org.apache.mina.filter.codec

Class SynchronizedProtocolDecoder

Implemented Interfaces:
ProtocolDecoder

public class SynchronizedProtocolDecoder
extends java.lang.Object
implements ProtocolDecoder

A 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 Summary

SynchronizedProtocolDecoder(ProtocolDecoder decoder)
Creates a new instance which decorates the specified decoder.

Method Summary

void
decode(IoSession session, ByteBuffer 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()
Returns the decoder this decoder is decorating.

Constructor Details

SynchronizedProtocolDecoder

public SynchronizedProtocolDecoder(ProtocolDecoder decoder)
Creates a new instance which decorates the specified decoder.

Method Details

decode

public void decode(IoSession session,
                   ByteBuffer in,
                   ProtocolDecoderOutput out)
            throws Exception
Decodes binary or protocol-specific content into higher-level message objects. MINA invokes ProtocolDecoder.decode(IoSession,ByteBuffer,ProtocolDecoderOutput) method with read data, and then the decoder implementation puts decoded messages into ProtocolDecoderOutput.
Specified by:
decode in interface ProtocolDecoder

dispose

public void dispose(IoSession session)
            throws Exception
Releases all resources related with this decoder.
Specified by:
dispose in interface ProtocolDecoder

finishDecode

public void finishDecode(IoSession session,
                         ProtocolDecoderOutput out)
            throws Exception
Invoked when the specified 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,ByteBuffer,ProtocolDecoderOutput) method didn't process completely.
Specified by:
finishDecode in interface ProtocolDecoder

getDecoder

public ProtocolDecoder getDecoder()
Returns the decoder this decoder is decorating.