Package io.netty.handler.codec.http.websocketx

Class WebSocket08FrameEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

io.netty.handler.codec.http.websocketx.WebSocket08FrameEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler, WebSocketFrameEncoder

Direct Known Subclasses:

WebSocket07FrameEncoder, WebSocket13FrameEncoder

public class WebSocket08FrameEncoder
extends MessageToMessageEncoder<WebSocketFrame>
implements WebSocketFrameEncoder

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

Nested Class Summary

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

ChannelHandler.Sharable

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
WebSocket08FrameEncoder(boolean maskPayload)	Constructor
WebSocket08FrameEncoder(WebSocketFrameMaskGenerator maskGenerator)	Constructor

Method Summary

Modifier and Type	Method	Description
private static void	addBuffers(ByteBuf buf, ByteBuf data, java.util.List<java.lang.Object> out)
protected void	encode(ChannelHandlerContext ctx, WebSocketFrame msg, java.util.List<java.lang.Object> out)	Encode from one message to an other.
private static byte	getOpCode(WebSocketFrame msg)

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

ensureNotSharable, 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

Methods inherited from interface io.netty.channel.ChannelOutboundHandler

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

Field Detail

logger

private static final InternalLogger logger

OPCODE_CONT

private static final byte OPCODE_CONT

See Also:

Constant Field Values

OPCODE_TEXT

private static final byte OPCODE_TEXT

See Also:

Constant Field Values

OPCODE_BINARY

private static final byte OPCODE_BINARY

See Also:

Constant Field Values

OPCODE_CLOSE

private static final byte OPCODE_CLOSE

See Also:

Constant Field Values

OPCODE_PING

private static final byte OPCODE_PING

See Also:

Constant Field Values

OPCODE_PONG

private static final byte OPCODE_PONG

See Also:

Constant Field Values

GATHERING_WRITE_THRESHOLD

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.

See Also:

Constant Field Values

maskGenerator

private final WebSocketFrameMaskGenerator maskGenerator

Constructor Detail

WebSocket08FrameEncoder

public WebSocket08FrameEncoder(boolean maskPayload)

Constructor

Parameters:

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

WebSocket08FrameEncoder

public WebSocket08FrameEncoder(WebSocketFrameMaskGenerator maskGenerator)

Constructor

Parameters:

maskGenerator - Web socket clients must set this to non null to mask payload. Server implementations must set this to null.

Method Detail

encode

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

Description copied from class: MessageToMessageEncoder

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

Specified by:

encode in class MessageToMessageEncoder<WebSocketFrame>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

out - the List into which the encoded msg should be added needs to do some kind of aggregation

Throws:

java.lang.Exception - is thrown if an error occurs

getOpCode

private static byte getOpCode(WebSocketFrame msg)

addBuffers

private static void addBuffers(ByteBuf buf,
                               ByteBuf data,
                               java.util.List<java.lang.Object> out)