io.socket.engineio.server.parser

Class ParserV3

java.lang.Object

io.socket.engineio.server.parser.ParserV3

All Implemented Interfaces:

Parser

public final class ParserV3
extends Object
implements Parser

Nested Class Summary

Nested classes/interfaces inherited from interface io.socket.engineio.server.parser.Parser

Parser.DecodePayloadCallback<T>, Parser.EncodeCallback<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROTOCOL

Fields inherited from interface io.socket.engineio.server.parser.Parser

ERROR_PACKET, PACKETS, PACKETS_REVERSE, PROTOCOL_V3, PROTOCOL_V4

Constructor Summary

Constructors

Constructor and Description
ParserV3()

Method Summary

Modifier and Type	Method and Description
Packet<?>	decodePacket(Object data) Decode a packet received from transport.
void	decodePayload(Object data, Parser.DecodePayloadCallback<Object> callback) Decode payload received from transport.
static void	encodeByteArray(Packet<byte[]> packet, boolean supportsBinary, Parser.EncodeCallback<Object> callback)
void	encodePacket(Packet<?> packet, boolean supportsBinary, Parser.EncodeCallback<Object> callback) Encode a packet for transfer over transport.
void	encodePayload(List<Packet<?>> packets, boolean supportsBinary, Parser.EncodeCallback<Object> callback) Encode an array of packets into a payload for transfer over transport.
void	encodePayloadAsBinary(List<Packet<?>> packets, Parser.EncodeCallback<Object> callback) Encode an array of packets into a binary payload for transfer over transport.
int	getProtocolVersion()

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL

public static final int PROTOCOL

See Also:

Constant Field Values

Constructor Detail

ParserV3

public ParserV3()

Method Detail

getProtocolVersion

public int getProtocolVersion()

Specified by:

getProtocolVersion in interface Parser

encodePacket

public void encodePacket(Packet<?> packet,
                         boolean supportsBinary,
                         Parser.EncodeCallback<Object> callback)

Encode a packet for transfer over transport.

Specified by:

encodePacket in interface Parser

Parameters:

packet - The packet to encode.

supportsBinary - Whether the transport supports binary encoding.

callback - The callback to be called with the encoded data.

encodeByteArray

public static void encodeByteArray(Packet<byte[]> packet,
                                   boolean supportsBinary,
                                   Parser.EncodeCallback<Object> callback)

encodePayload

public void encodePayload(List<Packet<?>> packets,
                          boolean supportsBinary,
                          Parser.EncodeCallback<Object> callback)

Encode an array of packets into a payload for transfer over transport.

Specified by:

encodePayload in interface Parser

Parameters:

packets - Array of packets to encode.

supportsBinary - Whether the transport supports binary encoding.

callback - The callback to be called with the encoded data.

decodePayload

public void decodePayload(Object data,
                          Parser.DecodePayloadCallback<Object> callback)

Decode payload received from transport.

Specified by:

decodePayload in interface Parser

Parameters:

data - Data received from transport.

callback - The callback to be called with each decoded packet in payload.

encodePayloadAsBinary

public void encodePayloadAsBinary(List<Packet<?>> packets,
                                  Parser.EncodeCallback<Object> callback)

Encode an array of packets into a binary payload for transfer over transport.

Parameters:

packets - Array of packets to encode.

callback - The callback to be called with the encoded data.

decodePacket

public Packet<?> decodePacket(Object data)

Decode a packet received from transport.

Specified by:

decodePacket in interface Parser

Parameters:

data - Data received from transport.

Returns:

Packet decoded from data.