org.snf4j.core.codec

Class EventDrivenCompoundEncoder<I,O>

java.lang.Object

org.snf4j.core.codec.CompoundEncoder<I,O>

org.snf4j.core.codec.EventDrivenCompoundEncoder<I,O>

Type Parameters:

I - the type of the accepted inbound objects

O - the type of the produced outbound objects

All Implemented Interfaces:

ICodec<I,O>, IEncoder<I,O>, IEventDrivenCodec

public abstract class EventDrivenCompoundEncoder<I,O>
extends CompoundEncoder<I,O>
implements IEventDrivenCodec

An event driven compound encoder that processes input data through a chain of the specified encoders.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
EventDrivenCompoundEncoder(IEncoder<?,?>... encoders) Constructs an event driven compound encoder with a chain of the specified encoders.

Method Summary

Modifier and Type	Method and Description
void	added(ISession session, ICodecPipeline pipeline) Signals that the codec has been added to the pipeline associated with a session.
void	event(ISession session, SessionEvent event) Signals a session event to the codec.
void	removed(ISession session, ICodecPipeline pipeline) Signals that the codec has been removed from the pipeline associated with a session.

Methods inherited from class org.snf4j.core.codec.CompoundEncoder

encode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.codec.ICodec

getInboundType, getOutboundType

Constructor Detail

EventDrivenCompoundEncoder

public EventDrivenCompoundEncoder(IEncoder<?,?>... encoders)

Constructs an event driven compound encoder with a chain of the specified encoders.

The encoder chain is organized in the following way:

 {data} -> encoder1 -> encoder2 -> ... -> encoderN -> {out}
 

Parameters:

encoders - the chain of encoders

Throws:

IllegalArgumentException - if the specified encoders have incompatible inbound or outbound types

IllegalStateException - if the param O is Void

Method Detail

added

public void added(ISession session,
                  ICodecPipeline pipeline)

Description copied from interface: IEventDrivenCodec

Signals that the codec has been added to the pipeline associated with a session.

Specified by:

added in interface IEventDrivenCodec

Parameters:

session - the session the pipeline is associated with

pipeline - the pipeline the codec has been added to

event

public void event(ISession session,
                  SessionEvent event)

Description copied from interface: IEventDrivenCodec

Signals a session event to the codec.

Specified by:

event in interface IEventDrivenCodec

Parameters:

session - the session which state is changing

event - the session event

removed

public void removed(ISession session,
                    ICodecPipeline pipeline)

Description copied from interface: IEventDrivenCodec

Signals that the codec has been removed from the pipeline associated with a session.

Specified by:

removed in interface IEventDrivenCodec

Parameters:

session - the session the pipeline is associated with

pipeline - the pipeline the codec has been removed from