public Class WebSocket08FrameEncoder

Class Inheritance

All Implemented Interfaces

Known Direct Subclasses

Imports

Encodes a web socket frame into wire protocol version 8 format. This code was forked from webbit and modified.

Field Summary

Modifier and Type	Field and Description
private static final int	GATHERING_WRITE_THRESHOLD The size threshold for gathering writes.
private static final InternalLogger	logger
private final boolean	maskPayload
private static final byte	OPCODE_BINARY
private static final byte	OPCODE_CLOSE
private static final byte	OPCODE_CONT
private static final byte	OPCODE_PING
private static final byte	OPCODE_PONG
private static final byte	OPCODE_TEXT

Access	Constructor and Description
public	WebSocket08FrameEncoder(boolean Web socket clients must set this to true to mask payload. Server implementations must set this to false. maskPayload) Constructor

Modifier and Type	Method and Description
protected void	encode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageEncoder` belongs to ctx, WebSocketFrame the message to encode to an other one msg, List<Object> the `List` into which the encoded msg should be added needs to do some kind of aggregation out) Implements abstract io.netty.handler.codec.MessageToMessageEncoder.encode. Encode from one message to an other.

Inherited from io.netty.handler.codec.MessageToMessageEncoder:: acceptOutboundMessage write

GATHERING_WRITE_THRESHOLD	back to summary
private static final int GATHERING_WRITE_THRESHOLD The size threshold for gathering writes. Non-Masked messages bigger than this size will be sent fragmented as a header and a content ByteBuf whereas messages smaller than the size will be merged into a single buffer and sent at once. Masked messages will always be sent at once.

logger	back to summary
private static final InternalLogger logger

maskPayload	back to summary
private final boolean maskPayload

OPCODE_BINARY	back to summary
private static final byte OPCODE_BINARY

OPCODE_CLOSE	back to summary
private static final byte OPCODE_CLOSE

OPCODE_CONT	back to summary
private static final byte OPCODE_CONT

OPCODE_PING	back to summary
private static final byte OPCODE_PING

OPCODE_PONG	back to summary
private static final byte OPCODE_PONG

OPCODE_TEXT	back to summary
private static final byte OPCODE_TEXT

WebSocket08FrameEncoder	back to summary
public WebSocket08FrameEncoder(boolean maskPayload) Constructor Parameters maskPayload:boolean Web socket clients must set this to true to mask payload. Server implementations must set this to false.

WebSocket08FrameEncoder

public WebSocket08FrameEncoder(boolean maskPayload)

Constructor

Parameters

maskPayload:boolean: Web socket clients must set this to true to mask payload. Server implementations must set this to false.

encode back to summary

encode	back to summary
protected void encode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.MessageToMessageEncoder.encode. Doc from io.netty.handler.codec.MessageToMessageEncoder.encode. Encode from one message to an other. This method will be called for each written message that can be handled by this encoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageEncoder` belongs to msg:WebSocketFrame the message to encode to an other one out:List<Object> the `List` into which the encoded msg should be added needs to do some kind of aggregation Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void encode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) throws Exception

Encode from one message to an other. This method will be called for each written message that can be handled by this encoder.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageEncoder belongs to
msg:WebSocketFrame: the message to encode to an other one
out:List<Object>: the List into which the encoded msg should be added needs to do some kind of aggregation

Annotations

Exceptions