io.netty.handler.codec.socksx.v5

Class Socks5ClientEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

io.netty.handler.codec.socksx.v5.Socks5ClientEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

@ChannelHandler.Sharable
public class Socks5ClientEncoder
extends MessageToByteEncoder<Socks5Message>

Encodes a client-side Socks5Message into a ByteBuf.

Nested Class Summary

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

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static Socks5ClientEncoder	DEFAULT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Socks5ClientEncoder() Creates a new instance with the default Socks5AddressEncoder.
	Socks5ClientEncoder(Socks5AddressEncoder addressEncoder) Creates a new instance with the specified Socks5AddressEncoder.

Method Summary

Modifier and Type	Method and Description
protected Socks5AddressEncoder	addressEncoder() Returns the Socks5AddressEncoder of this encoder.
protected void	encode(ChannelHandlerContext ctx, Socks5Message msg, ByteBuf out) Encode a message into a ByteBuf.

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

acceptOutboundMessage, allocateBuffer, isPreferDirect, 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

Field Detail

DEFAULT

public static final Socks5ClientEncoder DEFAULT

Constructor Detail

Socks5ClientEncoder

protected Socks5ClientEncoder()

Creates a new instance with the default Socks5AddressEncoder.

Socks5ClientEncoder

public Socks5ClientEncoder(Socks5AddressEncoder addressEncoder)

Creates a new instance with the specified Socks5AddressEncoder.

Method Detail

addressEncoder

protected final Socks5AddressEncoder addressEncoder()

Returns the Socks5AddressEncoder of this encoder.

encode

protected void encode(ChannelHandlerContext ctx,
                      Socks5Message msg,
                      ByteBuf out)
               throws 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<Socks5Message>

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:

Exception - is thrown if an error occurs