org.snf4j.core.codec

Class DefaultCodecExecutor

java.lang.Object

org.snf4j.core.codec.DefaultCodecExecutor

All Implemented Interfaces:

ICodecExecutor

public class DefaultCodecExecutor
extends Object
implements ICodecExecutor

The default implementation of the ICodecExecutor.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
DefaultCodecExecutor()

Method Summary

Modifier and Type	Method and Description
void	addChild(ISession session, ICodecExecutor executor) Adds a child codec executor that will be receiving session events received by this codec executor.
List<Object>	decode(ISession session, byte[] data) Decodes bytes from a byte array.
List<Object>	decode(ISession session, ByteBuffer data) Decodes bytes from a byte buffer.
List<Object>	encode(ISession session, byte[] data) Encodes bytes from a byte array.
List<Object>	encode(ISession session, ByteBuffer data) Encodes bytes from a byte buffer.
List<Object>	encode(ISession session, IByteBufferHolder data) Encodes bytes from a byte buffer holder.
List<Object>	encode(ISession session, Object msg) Encodes a message.
void	event(ISession session, SessionEvent event) Signals a session event to all event-driven codecs in the associated pipeline.
IBaseDecoder<?,?>	getBaseDecoder() Gets the base decoder.
ICodecPipeline	getPipeline() Returns the codec pipeline that is associated with this codec executor.
boolean	hasDecoders() Informs if the pipeline has decoders that produce outbound object(s).
void	syncDecoders(ISession session) Informs the codec executor that right now is the best moment to safely synchronize any pending changes for decoders in the associated pipeline.
void	syncEncoders(ISession session) Informs the codec executor that right now is the best moment to safely synchronize any pending changes for encoders in the associated pipeline.
void	syncEventDrivenCodecs(ISession session) Informs the codec executor that right now is the best moment to safely synchronize any pending changes for event-driven codecs in the associated pipeline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCodecExecutor

public DefaultCodecExecutor()

Method Detail

syncDecoders

public final void syncDecoders(ISession session)

Description copied from interface: ICodecExecutor

Informs the codec executor that right now is the best moment to safely synchronize any pending changes for decoders in the associated pipeline.

Performance considerations: This method is called every time new data need to be decoded and so it should not perform any heavy tasks.

Specified by:

syncDecoders in interface ICodecExecutor

Parameters:

session - the session the codec executor is associated with

syncEncoders

public final void syncEncoders(ISession session)

Description copied from interface: ICodecExecutor

Informs the codec executor that right now is the best moment to safely synchronize any pending changes for encoders in the associated pipeline.

Performance considerations: This method is called every time new data need to be encoded and so it should not perform any heavy tasks.

Specified by:

syncEncoders in interface ICodecExecutor

Parameters:

session - the session the codec executor is associated with

syncEventDrivenCodecs

public void syncEventDrivenCodecs(ISession session)

Description copied from interface: ICodecExecutor

Informs the codec executor that right now is the best moment to safely synchronize any pending changes for event-driven codecs in the associated pipeline. An Implementation of this method is responsible for signaling following events to event-driven codecs: adding and removing of a codec from the associated pipeline.

Performance considerations: This method is called every time the state of the associated session is changing so it should not perform any heavy tasks.

Specified by:

syncEventDrivenCodecs in interface ICodecExecutor

Parameters:

session - the session the codec executor is associated with

See Also:

IEventDrivenCodec

getPipeline

public final ICodecPipeline getPipeline()

Description copied from interface: ICodecExecutor

Returns the codec pipeline that is associated with this codec executor.

Specified by:

getPipeline in interface ICodecExecutor

Returns:

the codec pipeline.

hasDecoders

public boolean hasDecoders()

Description copied from interface: ICodecExecutor

Informs if the pipeline has decoders that produce outbound object(s).

The returned value should not be affected by changes in the associated pipeline that have not been synchronized yet by calling ICodecExecutor.syncDecoders(org.snf4j.core.session.ISession).

Performance considerations: This method is called every time new data need to be decoded and so it should not perform any heavy tasks.

Specified by:

hasDecoders in interface ICodecExecutor

Returns:

true if the pipeline has at least one encoder that produces outbound object(s).

encode

public List<Object> encode(ISession session,
                           ByteBuffer data)
                    throws Exception

Description copied from interface: ICodecExecutor

Encodes bytes from a byte buffer.

This method should ignore all changes in the associated pipeline that have not been synchronized yet by calling ICodecExecutor.syncEncoders(org.snf4j.core.session.ISession).

Specified by:

encode in interface ICodecExecutor

Parameters:

session - the session for which the encoding is performed

data - the bytes to encode

Returns:

a list of produced outbound objects, or null if the pipeline is empty or has no encoders that produce outbound object(s)

Throws:

Exception - if one of the encoders failed during the encoding

encode

public List<Object> encode(ISession session,
                           IByteBufferHolder data)
                    throws Exception

Description copied from interface: ICodecExecutor

Encodes bytes from a byte buffer holder.

This method should ignore all changes in the associated pipeline that have not been synchronized yet by calling ICodecExecutor.syncEncoders(org.snf4j.core.session.ISession).

Specified by:

encode in interface ICodecExecutor

Parameters:

session - the session for which the encoding is performed

data - the bytes to encode

Returns:

a list of produced outbound objects, or null if the pipeline is empty or has no encoders that produce outbound object(s)

Throws:

Exception - if one of the encoders failed during the encoding

encode

public List<Object> encode(ISession session,
                           byte[] data)
                    throws Exception

Description copied from interface: ICodecExecutor

Encodes bytes from a byte array.

This method should ignore all changes in the associated pipeline that have not been synchronized yet by calling ICodecExecutor.syncEncoders(org.snf4j.core.session.ISession).

Specified by:

encode in interface ICodecExecutor

Parameters:

session - the session for which the encoding is performed

data - the bytes to encode

Returns:

a list of produced outbound objects, or null if the pipeline is empty or has no encoders that produce outbound object(s)

Throws:

Exception - if one of the encoders failed during the encoding

encode

public List<Object> encode(ISession session,
                           Object msg)
                    throws Exception

Description copied from interface: ICodecExecutor

Encodes a message.

This method should ignore all changes in the associated pipeline that have not been synchronized yet by calling ICodecExecutor.syncEncoders(org.snf4j.core.session.ISession).

Specified by:

encode in interface ICodecExecutor

Parameters:

session - the session for which the encoding is performed

msg - the message to encode

Returns:

a list of produced outbound objects, or null if the pipeline is empty or has no encoders that produce outbound object(s)

Throws:

Exception - if one of the encoders failed during the encoding

decode

public List<Object> decode(ISession session,
                           byte[] data)
                    throws Exception

Description copied from interface: ICodecExecutor

Decodes bytes from a byte array.

This method should ignore all changes in the associated pipeline that have not been synchronized yet by calling ICodecExecutor.syncDecoders(org.snf4j.core.session.ISession).

Specified by:

decode in interface ICodecExecutor

Parameters:

session - the session for which the decoding is performed

data - the bytes to decode

Returns:

a list of produced outbound objects, or null if the pipeline is empty or has no decoders that produce outbound object(s)

Throws:

Exception - if one of the decoders failed during the decoding

decode

public List<Object> decode(ISession session,
                           ByteBuffer data)
                    throws Exception

Description copied from interface: ICodecExecutor

Decodes bytes from a byte buffer.

This method should ignore all changes in the associated pipeline that have not been synchronized yet by calling ICodecExecutor.syncDecoders(org.snf4j.core.session.ISession).

Specified by:

decode in interface ICodecExecutor

Parameters:

session - the session for which the decoding is performed

data - the bytes to decode

Returns:

a list of produced outbound objects, or null if the pipeline is empty or has no decoders that produce outbound object(s)

Throws:

Exception - if one of the decoders failed during the decoding

getBaseDecoder

public final IBaseDecoder<?,?> getBaseDecoder()

Description copied from interface: ICodecExecutor

Gets the base decoder.

The returned value should not be affected by changes in the associated pipeline that have not been synchronized yet by calling ICodecExecutor.syncDecoders(org.snf4j.core.session.ISession).

Performance considerations: This method is called every time new data need to be decoded and so it should not perform any heavy tasks.

Specified by:

getBaseDecoder in interface ICodecExecutor

Returns:

the first decoder in the pipeline but only if it implements IBaseDecoder, if the first decoder does not implement it then null should be returned.

event

public void event(ISession session,
                  SessionEvent event)

Description copied from interface: ICodecExecutor

Signals a session event to all event-driven codecs in the associated pipeline.

Specified by:

event in interface ICodecExecutor

Parameters:

session - the session the codec executor is associated with

event - the session event

addChild

public void addChild(ISession session,
                     ICodecExecutor executor)

Description copied from interface: ICodecExecutor

Adds a child codec executor that will be receiving session events received by this codec executor.

Specified by:

addChild in interface ICodecExecutor

Parameters:

session - the session the codec executor is associated with

executor - a child codec executor