Class WebSocket08FrameEncoder

java.lang.Object

org.jboss.netty.handler.codec.oneone.OneToOneEncoder

org.jboss.netty.handler.codec.http.websocketx.WebSocket08FrameEncoder

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler

Direct Known Subclasses:

WebSocket07FrameEncoder, WebSocket13FrameEncoder

public class WebSocket08FrameEncoder
extends OneToOneEncoder

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

Field Summary

Fields

Modifier and Type	Field	Description
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

Constructor Summary

Constructors

Constructor	Description
WebSocket08FrameEncoder(boolean maskPayload)	Constructor

Method Summary

Modifier and Type	Method	Description
protected Object	encode(ChannelHandlerContext ctx, Channel channel, Object msg)	Transforms the specified message into another message and return the transformed message.

Methods inherited from class OneToOneEncoder

doEncode, handleDownstream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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

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 Object encode(ChannelHandlerContext ctx,
 Channel channel,
 Object msg)
                 throws Exception

Description copied from class: OneToOneEncoder

Transforms the specified message into another message and return the transformed message. Note that you can not return null, unlike you can in OneToOneDecoder.decode(ChannelHandlerContext, Channel, Object); you must return something, at least ChannelBuffers.EMPTY_BUFFER.

Specified by:

encode in class OneToOneEncoder

Throws:

Exception