Netty/Codec/Socks 5.0.0.Alpha2 · io.netty.contrib.handler.codec.socksx.v5.Socks5ClientEncoder

Modifier and Type	Field and Description
private final Socks5AddressEncoder	addressEncoder
public static final Socks5ClientEncoder	DEFAULT

Modifier and Type

Field and Description

private final Socks5AddressEncoder

addressEncoder

public static final Socks5ClientEncoder

DEFAULT

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

Access

Constructor and Description

protected

Socks5ClientEncoder()

Creates a new instance with the default Socks5AddressEncoder.

public

Socks5ClientEncoder(Socks5AddressEncoder addressEncoder)

Creates a new instance with the specified Socks5AddressEncoder.

Modifier and Type	Method and Description
protected final Socks5AddressEncoder	addressEncoder() Returns the `Socks5AddressEncoder` of this encoder.
protected Buffer	allocateBuffer(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to ctx, Socks5Message the message to be encoded msg) Implements abstract io.netty5.handler.codec.MessageToByteEncoder.allocateBuffer. Allocate a `Buffer` which will be used as argument of `encode(ChannelHandlerContext, I, Buffer)`.
protected void	encode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to ctx, Socks5Message the message to encode msg, Buffer the `Buffer` into which the encoded message will be written out) Implements abstract io.netty5.handler.codec.MessageToByteEncoder.encode. Encode a message into a `Buffer`.
private static void	encodeAuthMethodRequest(Socks5InitialRequest msg, Buffer out)
private void	encodeCommandRequest(Socks5CommandRequest msg, Buffer out)
private static void	encodePasswordAuthRequest(Socks5PasswordAuthRequest msg, Buffer out)
public boolean	isSharable() Overrides default io.netty5.channel.ChannelHandler.isSharable. Returns `true` if this handler is sharable and thus can be added to more than one `ChannelPipeline`.

Modifier and Type

Method and Description

protected final Socks5AddressEncoder

addressEncoder()

Returns the Socks5AddressEncoder of this encoder.

protected Buffer

allocateBuffer(ChannelHandlerContext

the ChannelHandlerContext which this MessageToByteEncoder belongs to

ctx, Socks5Message

the message to be encoded

msg)

Implements abstract io.netty5.handler.codec.MessageToByteEncoder.allocateBuffer.

Allocate a Buffer which will be used as argument of encode(ChannelHandlerContext, I, Buffer).

protected void

encode(ChannelHandlerContext

the ChannelHandlerContext which this MessageToByteEncoder belongs to

ctx, Socks5Message

the message to encode

msg, Buffer

the Buffer into which the encoded message will be written

out)

Implements abstract io.netty5.handler.codec.MessageToByteEncoder.encode.

Encode a message into a Buffer.

private static void

encodeAuthMethodRequest(Socks5InitialRequest msg, Buffer out)

private void

encodeCommandRequest(Socks5CommandRequest msg, Buffer out)

private static void

encodePasswordAuthRequest(Socks5PasswordAuthRequest msg, Buffer out)

public boolean

isSharable()

Overrides default io.netty5.channel.ChannelHandler.isSharable.

Returns true if this handler is sharable and thus can be added to more than one ChannelPipeline.

addressEncoder	back to summary
private final Socks5AddressEncoder addressEncoder

addressEncoder

back to summary

private final Socks5AddressEncoder addressEncoder

DEFAULT	back to summary
public static final Socks5ClientEncoder DEFAULT

DEFAULT

back to summary

public static final Socks5ClientEncoder DEFAULT

Socks5ClientEncoder	back to summary
protected Socks5ClientEncoder() Creates a new instance with the default `Socks5AddressEncoder`.

Socks5ClientEncoder

back to summary

protected Socks5ClientEncoder()

Creates a new instance with the default Socks5AddressEncoder.

Socks5ClientEncoder	back to summary
public Socks5ClientEncoder(Socks5AddressEncoder addressEncoder) Creates a new instance with the specified `Socks5AddressEncoder`.

Socks5ClientEncoder

back to summary

public Socks5ClientEncoder(Socks5AddressEncoder addressEncoder)

Creates a new instance with the specified Socks5AddressEncoder.

Method Detail

addressEncoder	back to summary
protected final Socks5AddressEncoder addressEncoder() Returns the `Socks5AddressEncoder` of this encoder.

allocateBuffer back to summary

allocateBuffer	back to summary
protected Buffer allocateBuffer(ChannelHandlerContext ctx, Socks5Message msg) Implements abstract io.netty5.handler.codec.MessageToByteEncoder.allocateBuffer. Doc from io.netty5.handler.codec.MessageToByteEncoder.allocateBuffer. Allocate a `Buffer` which will be used as argument of `encode(ChannelHandlerContext, I, Buffer)`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to msg:Socks5Message the message to be encoded Annotations @Override

protected Buffer allocateBuffer(ChannelHandlerContext ctx, Socks5Message msg)

Implements abstract io.netty5.handler.codec.MessageToByteEncoder.allocateBuffer.

Doc from io.netty5.handler.codec.MessageToByteEncoder.allocateBuffer.

Allocate a Buffer which will be used as argument of encode(ChannelHandlerContext, I, Buffer).

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToByteEncoder belongs to
msg:Socks5Message: the message to be encoded

Annotations

@Override

encode back to summary

encode	back to summary
protected void encode(ChannelHandlerContext ctx, Socks5Message msg, Buffer out) throws Exception Implements abstract io.netty5.handler.codec.MessageToByteEncoder.encode. Doc from io.netty5.handler.codec.MessageToByteEncoder.encode. Encode a message into a `Buffer`. This method will be called for each written message that can be handled by this encoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to msg:Socks5Message the message to encode out:Buffer the `Buffer` into which the encoded message will be written Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void encode(ChannelHandlerContext ctx, Socks5Message msg, Buffer out) throws Exception

Implements abstract io.netty5.handler.codec.MessageToByteEncoder.encode.

Doc from io.netty5.handler.codec.MessageToByteEncoder.encode.

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

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToByteEncoder belongs to
msg:Socks5Message: the message to encode
out:Buffer: the Buffer into which the encoded message will be written

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

encodeAuthMethodRequest	back to summary
private static void encodeAuthMethodRequest(Socks5InitialRequest msg, Buffer out)

encodeCommandRequest	back to summary
private void encodeCommandRequest(Socks5CommandRequest msg, Buffer out) throws Exception

encodePasswordAuthRequest	back to summary
private static void encodePasswordAuthRequest(Socks5PasswordAuthRequest msg, Buffer out)

isSharable back to summary

isSharable	back to summary
public boolean isSharable() Overrides default io.netty5.channel.ChannelHandler.isSharable. Doc from io.netty5.channel.ChannelHandler.isSharable. Returns `true` if this handler is sharable and thus can be added to more than one `ChannelPipeline`. By default, this method returns `false`. If this method returns `false`, you have to create a new handler instance every time you add it to a pipeline because it has unshared state such as member variables. Annotations @Override

public boolean isSharable()

Overrides default io.netty5.channel.ChannelHandler.isSharable.

Doc from io.netty5.channel.ChannelHandler.isSharable.

Returns true if this handler is sharable and thus can be added to more than one ChannelPipeline. By default, this method returns false. If this method returns false, you have to create a new handler instance every time you add it to a pipeline because it has unshared state such as member variables.

Annotations

@Override

public Class Socks5ClientEncoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail