io.netty.handler.codec.socks

Class SocksMessageEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToByteEncoder<SocksMessage>

io.netty.handler.codec.socks.SocksMessageEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

@ChannelHandler.Sharable
public class SocksMessageEncoder
extends MessageToByteEncoder<SocksMessage>

Encodes an SocksMessage into a ByteBuf. MessageToByteEncoder implementation. Use this with SocksInitRequest, SocksInitResponse, SocksAuthRequest, SocksAuthResponse, SocksCmdRequest and SocksCmdResponse

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
SocksMessageEncoder()

Method Summary

Modifier and Type	Method and Description
protected void	encode(ChannelHandlerContext ctx, SocksMessage msg, ByteBuf out) Encode a message into a ByteBuf.
static java.lang.String	getName() Deprecated. Will be removed at the next minor version bump.

Methods inherited from class io.netty.handler.codec.MessageToByteEncoder

acceptOutboundMessage, allocateBuffer, 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.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

SocksMessageEncoder

public SocksMessageEncoder()

Method Detail

getName

@Deprecated
public static java.lang.String getName()

Deprecated. Will be removed at the next minor version bump.

encode

protected void encode(ChannelHandlerContext ctx,
                      SocksMessage msg,
                      ByteBuf out)
               throws java.lang.Exception

Description copied from class: MessageToByteEncoder

Encode a message into a ByteBuf. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToByteEncoder<SocksMessage>

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

java.lang.Exception - is thrown if an error occurs