public class SynchronizedProtocolDecoder extends Object implements ProtocolDecoder
ProtocolDecoder
implementation which decorates an existing decoder
to be thread-safe. Please be careful if you're going to use this decorator
because it can be a root of performance degradation in a multi-thread
environment. Also, by default, appropriate synchronization is done
on a per-session basis by ProtocolCodecFilter
. Please use this
decorator only when you need to synchronize on a per-decoder basis, which
is not common.Constructor and Description |
---|
SynchronizedProtocolDecoder(ProtocolDecoder decoder)
Creates a new instance which decorates the specified
decoder . |
Modifier and Type | Method and Description |
---|---|
void |
decode(IoSession session,
IoBuffer in,
ProtocolDecoderOutput out)
Decodes binary or protocol-specific content into higher-level message objects.
|
void |
dispose(IoSession session)
Releases all resources related with this decoder.
|
void |
finishDecode(IoSession session,
ProtocolDecoderOutput out)
Invoked when the specified
session is closed. |
ProtocolDecoder |
getDecoder() |
public SynchronizedProtocolDecoder(ProtocolDecoder decoder)
decoder
.decoder
- The decorated decoderpublic ProtocolDecoder getDecoder()
public void decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception
ProtocolDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput)
method with read data, and then the decoder implementation puts decoded
messages into ProtocolDecoderOutput
.decode
in interface ProtocolDecoder
session
- The current Sessionin
- the buffer to decodeout
- The ProtocolDecoderOutput
that will receive the decoded messageException
- if the read data violated protocol specificationpublic void finishDecode(IoSession session, ProtocolDecoderOutput out) throws Exception
session
is closed. This method is useful
when you deal with the protocol which doesn't specify the length of a message
such as HTTP response without content-length
header. Implement this
method to process the remaining data that ProtocolDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput)
method didn't process completely.finishDecode
in interface ProtocolDecoder
session
- The current Sessionout
- The ProtocolDecoderOutput
that contains the decoded messageException
- if the read data violated protocol specificationpublic void dispose(IoSession session) throws Exception
dispose
in interface ProtocolDecoder
session
- The current SessionException
- if failed to dispose all resourcesCopyright © 2004–2024 Apache MINA Project. All rights reserved.