ProtocolCodec

All Known Subinterfaces:

WrappingProtocolCodec

All Known Implementing Classes:

AbstractProtocolCodec, SslProtocolCodec
```
public interface ProtocolCodec
```
Interface to encode and decode commands in and out of a a non blocking channel.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ProtocolCodec.BufferState

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ProtocolCodec.BufferState`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ProtocolCodec.BufferState`	`flush()` Attempts to complete the previous write which did not complete.
`boolean`	`full()` Is the codec's buffer full?
`long`	`getLastReadSize()`
`long`	`getLastWriteSize()`
`int`	`getReadBufferSize()`
`long`	`getReadCounter()`
`int`	`getWriteBufferSize()`
`long`	`getWriteCounter()`
`java.lang.Object`	`read()` Non-blocking channel based decoding.
`void`	`setTransport(Transport transport)`
`void`	`unread(byte[] buffer)` Pushes back a buffer as being unread.
`ProtocolCodec.BufferState`	`write(java.lang.Object value)` Non-blocking channel based encoding.

- Method Detail
  - setTransport
```
void setTransport(Transport transport)
```
  - read
```
java.lang.Object read()
               throws java.io.IOException
```
    Non-blocking channel based decoding.
    
    Returns:
    
    Throws:
    
    java.io.IOException
  - unread
```
void unread(byte[] buffer)
```
    Pushes back a buffer as being unread.
    
    Parameters:
    
    buffer -
  - getReadCounter
```
long getReadCounter()
```
    Returns:
    
    The number of bytes received.
  - getLastReadSize
```
long getLastReadSize()
```
    Returns:
    
    The number of bytes read in the last read io performed.
  - getReadBufferSize
```
int getReadBufferSize()
```
  - getWriteBufferSize
```
int getWriteBufferSize()
```
  - write
```
ProtocolCodec.BufferState write(java.lang.Object value)
                         throws java.io.IOException
```
    Non-blocking channel based encoding.
    
    Returns:
    
    true if the write completed.
    
    Throws:
    
    java.io.IOException
  - flush
```
ProtocolCodec.BufferState flush()
                         throws java.io.IOException
```
    Attempts to complete the previous write which did not complete.
    
    Returns:
    
    Throws:
    
    java.io.IOException
  - full
```
boolean full()
```
    Is the codec's buffer full?
    
    Returns:
  - getWriteCounter
```
long getWriteCounter()
```
    Returns:
    
    The number of bytes written.
  - getLastWriteSize
```
long getLastWriteSize()
```
    Returns:
    
    The number of bytes read in the last write io performed.

Interface ProtocolCodec

Nested Class Summary

Method Summary

Method Detail

setTransport

read

unread

getReadCounter

getLastReadSize

getReadBufferSize

getWriteBufferSize

write

flush

full

getWriteCounter

getLastWriteSize