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

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 org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
private static InternalLogger	logger
private boolean	maskPayload
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 and Description
WebSocket08FrameEncoder(boolean maskPayload) Constructor

Method Summary

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

Methods inherited from class org.jboss.netty.handler.codec.oneone.OneToOneEncoder

doEncode, handleDownstream

Methods inherited from class java.lang.Object

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

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

maskPayload

private final boolean maskPayload

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 java.lang.Object encode(ChannelHandlerContext ctx,
                                  Channel channel,
                                  java.lang.Object msg)
                           throws java.lang.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:

java.lang.Exception