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

Constructor Summary

Constructors

Constructor and Description
WebSocket08FrameEncoder(boolean maskPayload) Constructor

Method Summary

Modifier and Type	Method and Description
protected 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.ChannelOutboundHandler

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

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

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.

Method Detail

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 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:

Exception - is thrown if an error occurs