org.snf4j.websocket.handshake

Class HandshakeEncoder

java.lang.Object

org.snf4j.websocket.handshake.HandshakeEncoder

All Implemented Interfaces:

ICodec<HandshakeFrame,ByteBuffer>, IEncoder<HandshakeFrame,ByteBuffer>, IEventDrivenCodec

public class HandshakeEncoder
extends Object
implements IEncoder<HandshakeFrame,ByteBuffer>, IEventDrivenCodec

Encodes a Web Socket handshake frame into bytes in the protocol version 13 format.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
HandshakeEncoder(boolean clientMode) Constructs a Web Socket handshake encoder.

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	encode(ISession session, HandshakeFrame data, List<ByteBuffer> out) Encodes data from one type to another one.
void	event(ISession session, SessionEvent event) Signals a session event to the codec.
Class<HandshakeFrame>	getInboundType() Returns the type of the accepted inbound objects.
Class<ByteBuffer>	getOutboundType() Returns the type of the produced outbound objects.
void	removed(ISession session, ICodecPipeline pipeline) Signals that the codec has been removed from the pipeline associated with a session.

Methods inherited from class java.lang.Object

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

Constructor Detail

HandshakeEncoder

public HandshakeEncoder(boolean clientMode)

Constructs a Web Socket handshake encoder.

Parameters:

clientMode - determines the mode (client/server) in which the encoder should work

Method Detail

getInboundType

public Class<HandshakeFrame> getInboundType()

Description copied from interface: ICodec

Returns the type of the accepted inbound objects.

Specified by:

getInboundType in interface ICodec<HandshakeFrame,ByteBuffer>

Returns:

the type of the inbound objects

getOutboundType

public Class<ByteBuffer> getOutboundType()

Description copied from interface: ICodec

Returns the type of the produced outbound objects.

Specified by:

getOutboundType in interface ICodec<HandshakeFrame,ByteBuffer>

Returns:

the type of the outbound objects

encode

public void encode(ISession session,
                   HandshakeFrame data,
                   List<ByteBuffer> out)
            throws Exception

Description copied from interface: IEncoder

Encodes data from one type to another one.

Encoders that do not produce an output (i.e. the O parameter is Void) cannot change the object passed as the data argument. They should not also store it for future use as its state can be changed.

The above limitations regarding the data argument do not apply to encoders that produce an output.

Specified by:

encode in interface IEncoder<HandshakeFrame,ByteBuffer>

Parameters:

session - the ISession which the passed data belongs to

data - the data to decode to another one

out - the List to which the decoded data should be added, or null if O is Void

Throws:

Exception - is thrown, if an error occur

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