|
||||||||||
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(ProtocolSession, ByteBuffer) and
decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput) . |
static MessageDecoderResult |
NOT_OK
Represents a result from decodable(ProtocolSession, ByteBuffer) and
decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput) . |
static MessageDecoderResult |
OK
Represents a result from decodable(ProtocolSession, ByteBuffer) and
decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput) . |
Method Summary | |
---|---|
MessageDecoderResult |
decodable(ProtocolSession session,
ByteBuffer in)
Checks the specified buffer is decodable by this decoder. |
MessageDecoderResult |
decode(ProtocolSession session,
ByteBuffer in,
ProtocolDecoderOutput out)
Decodes binary or protocol-specific content into higher-level message objects. |
Field Detail |
---|
static final MessageDecoderResult OK
decodable(ProtocolSession, ByteBuffer)
and
decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput)
. Please
refer to each method's documentation for detailed explanation.
static final MessageDecoderResult NEED_DATA
decodable(ProtocolSession, ByteBuffer)
and
decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput)
. Please
refer to each method's documentation for detailed explanation.
static final MessageDecoderResult NOT_OK
decodable(ProtocolSession, ByteBuffer)
and
decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput)
. Please
refer to each method's documentation for detailed explanation.
Method Detail |
---|
MessageDecoderResult decodable(ProtocolSession 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(ProtocolSession session, ByteBuffer in, ProtocolDecoderOutput out) throws ProtocolViolationException
decode(ProtocolSession, 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.
ProtocolViolationException
- if the read data violated protocol
specification
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |