org.jboss.netty.handler.codec.http.websocket

Class WebSocketFrameEncoder

java.lang.Object

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

org.jboss.netty.handler.codec.http.websocket.WebSocketFrameEncoder

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler

@ChannelHandler.Sharable
public class WebSocketFrameEncoder
extends OneToOneEncoder

Encodes a WebSocketFrame into a ChannelBuffer.

For the detailed instruction on adding add Web Socket support to your HTTP server, take a look into the WebSocketServer example located in the org.jboss.netty.example.http.websocket package.

Version:

$Rev: 2362 $, $Date: 2010-09-09 19:59:22 +0900 (Thu, 09 Sep 2010) $

Author:

The Netty Project, Mike Heath (mheath@apache.org), Trustin Lee

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
WebSocketFrameEncoder()

Method Summary

Methods

Modifier and Type	Method and 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 org.jboss.netty.handler.codec.oneone.OneToOneEncoder

handleDownstream

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketFrameEncoder

public WebSocketFrameEncoder()

Method Detail

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