|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface MessageDecoder
Decodes specific messages.
DemuxingProtocolCodecFactory,
MessageDecoderFactory| Field Summary | |
|---|---|
static MessageDecoderResult |
NEED_DATA
Represents a result from decodable(IoSession, ByteBuffer) and
decode(IoSession, ByteBuffer, ProtocolDecoderOutput). |
static MessageDecoderResult |
NOT_OK
Represents a result from decodable(IoSession, ByteBuffer) and
decode(IoSession, ByteBuffer, ProtocolDecoderOutput). |
static MessageDecoderResult |
OK
Represents a result from decodable(IoSession, ByteBuffer) and
decode(IoSession, ByteBuffer, ProtocolDecoderOutput). |
| Method Summary | |
|---|---|
MessageDecoderResult |
decodable(IoSession session,
ByteBuffer in)
Checks the specified buffer is decodable by this decoder. |
MessageDecoderResult |
decode(IoSession session,
ByteBuffer in,
ProtocolDecoderOutput out)
Decodes binary or protocol-specific content into higher-level message objects. |
void |
finishDecode(IoSession session,
ProtocolDecoderOutput out)
Invoked when the specified session is closed while this decoder was parsing the data. |
| Field Detail |
|---|
static final MessageDecoderResult OK
decodable(IoSession, ByteBuffer) and
decode(IoSession, ByteBuffer, ProtocolDecoderOutput). Please
refer to each method's documentation for detailed explanation.
static final MessageDecoderResult NEED_DATA
decodable(IoSession, ByteBuffer) and
decode(IoSession, ByteBuffer, ProtocolDecoderOutput). Please
refer to each method's documentation for detailed explanation.
static final MessageDecoderResult NOT_OK
decodable(IoSession, ByteBuffer) and
decode(IoSession, ByteBuffer, ProtocolDecoderOutput). Please
refer to each method's documentation for detailed explanation.
| Method Detail |
|---|
MessageDecoderResult decodable(IoSession session,
ByteBuffer in)
OK if this decoder can decode the specified buffer.
NOT_OK if this decoder cannot decode the specified buffer.
NEED_DATA if more data is required to determine if the
specified buffer is decodable (OK) or not decodable
NOT_OK.
MessageDecoderResult decode(IoSession session,
ByteBuffer in,
ProtocolDecoderOutput out)
throws Exception
decode(IoSession, ByteBuffer, ProtocolDecoderOutput)
method with read data, and then the decoder implementation puts decoded
messages into ProtocolDecoderOutput.
OK if you finished decoding messages successfully.
NEED_DATA if you need more data to finish decoding current message.
NOT_OK if you cannot decode current message due to protocol specification violation.
Exception - if the read data violated protocol specification
void finishDecode(IoSession session,
ProtocolDecoderOutput out)
throws Exception
decode(IoSession, ByteBuffer, ProtocolDecoderOutput) method didn't process
completely.
Exception - if the read data violated protocol specification
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||