io.scalecube.socketio.serialization

Class PacketEncoder

java.lang.Object

io.scalecube.socketio.serialization.PacketEncoder

public final class PacketEncoder
extends Object

Class that provides encoding Socket.IO packets according to specification below.

Encoding

Messages have to be encoded before 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:

Anton Kharenko

Method Summary

Modifier and Type	Method and Description
static io.netty.buffer.ByteBuf	encodePacket(Packet packet)

Methods inherited from class java.lang.Object

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

Method Detail

encodePacket

public static io.netty.buffer.ByteBuf encodePacket(Packet packet)
                                            throws IOException

Throws:

IOException