io.scalecube.socketio.pipeline

Class PacketEncoderHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<Object>

io.scalecube.socketio.pipeline.PacketEncoderHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler

@ChannelHandler.Sharable
public class PacketEncoderHandler
extends io.netty.handler.codec.MessageToMessageEncoder<Object>

This class encodes Socket.IO messages they're sent. The structure of a message is as follows:

[message type] ':' [message id ('+')] ':' [message endpoint] (':' [message data])

The message type is a single digit integer. The message id is an incremental integer, required for ACKs (can be ommitted). If the message id is followed by a +, the ACK is not handled by socket.io, but by the user instead. Socket.IO has built-in support for multiple channels of communication (which we call "multiple sockets"). Each socket is identified by an endpoint (can be omitted).

Author:

Ronen Hamias, Anton Kharenko

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
PacketEncoderHandler()

Method Summary

Modifier and Type	Method and Description
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, Object msg, List<Object> out)

Methods inherited from class io.netty.handler.codec.MessageToMessageEncoder

acceptOutboundMessage, write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

PacketEncoderHandler

public PacketEncoderHandler()

Method Detail

encode

protected void encode(io.netty.channel.ChannelHandlerContext ctx,
                      Object msg,
                      List<Object> out)
               throws Exception

Specified by:

encode in class io.netty.handler.codec.MessageToMessageEncoder<Object>

Throws:

Exception