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
FieldsModifier and TypeFieldDescriptionprivate static final int
The size threshold for gathering writes.private static final InternalLogger
private final boolean
private static final byte
private static final byte
private static final byte
private static final byte
private static final byte
private static final byte
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
encode
(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) Encode from one message to an other.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 Details
-
logger
-
OPCODE_CONT
private static final byte OPCODE_CONT- See Also:
-
OPCODE_TEXT
private static final byte OPCODE_TEXT- See Also:
-
OPCODE_BINARY
private static final byte OPCODE_BINARY- See Also:
-
OPCODE_CLOSE
private static final byte OPCODE_CLOSE- See Also:
-
OPCODE_PING
private static final byte OPCODE_PING- See Also:
-
OPCODE_PONG
private static final byte OPCODE_PONG- See Also:
-
GATHERING_WRITE_THRESHOLD
private static final int GATHERING_WRITE_THRESHOLDThe 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:
-
maskPayload
private final boolean maskPayload
-
-
Constructor Details
-
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.
-
-
Method Details
-
encode
protected void encode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) throws 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 classMessageToMessageEncoder<WebSocketFrame>
- Parameters:
ctx
- theChannelHandlerContext
which thisMessageToMessageEncoder
belongs tomsg
- the message to encode to an other oneout
- theList
into which the encoded msg should be added needs to do some kind of aggregation- Throws:
Exception
- is thrown if an error occurs
-