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 ChannelHandler
ChannelHandler.Sharable -
Constructor Summary
ConstructorsConstructorDescriptionWebSocket08FrameEncoder(boolean maskPayload) ConstructorWebSocket08FrameEncoder(WebSocketFrameMaskGenerator maskGenerator) Constructor -
Method Summary
Modifier and TypeMethodDescriptionprotected voidencode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) Encode from one message to an other.Methods inherited from class MessageToMessageEncoder
acceptOutboundMessage, writeMethods inherited from class ChannelOutboundHandlerAdapter
bind, close, connect, deregister, disconnect, flush, readMethods inherited from class ChannelHandlerAdapter
ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharableMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ChannelHandler
exceptionCaught, handlerAdded, handlerRemovedMethods inherited from interface ChannelOutboundHandler
bind, close, connect, deregister, disconnect, flush, read, write
-
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.
-
WebSocket08FrameEncoder
Constructor- Parameters:
maskGenerator- Web socket clients must set this tonon nullto mask payload. Server implementations must set this tonull.
-
-
Method Details
-
encode
protected void encode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) throws Exception Description copied from class:MessageToMessageEncoderEncode from one message to an other. This method will be called for each written message that can be handled by this encoder.- Specified by:
encodein classMessageToMessageEncoder<WebSocketFrame>- Parameters:
ctx- theChannelHandlerContextwhich thisMessageToMessageEncoderbelongs tomsg- the message to encode to an other oneout- theListinto which the encoded msg should be added needs to do some kind of aggregation- Throws:
Exception- is thrown if an error occurs
-