Top Description Inners Fields Constructors Methods
io.netty.contrib.handler.codec.socksx.v5

public Class Socks5CommandResponseDecoder

extends ByteToMessageDecoder
Class Inheritance
Imports
io.netty5.buffer.Buffer, io.netty5.channel.ChannelHandlerContext, io.netty5.handler.codec.ByteToMessageDecoder, .DecoderException, .DecoderResult, io.netty.contrib.handler.codec.socksx.SocksVersion
Decodes a single Socks5CommandResponse from the inbound Buffers. On successful decode, this decoder will forward the received data to the next handler, so that other handler can remove or replace this decoder later. On failed decode, this decoder will discard the received data, so that other handler closes the connection later.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static enum
Socks5CommandResponseDecoder.State

Field Summary

Modifier and TypeField and Description
private final Socks5AddressDecoder
addressDecoder

private Socks5CommandResponseDecoder.State
state

Inherited from io.netty5.handler.codec.ByteToMessageDecoder:
COMPOSITE_CUMULATORMERGE_CUMULATOR

Constructor Summary

AccessConstructor and Description
public
Socks5CommandResponseDecoder()

public
Socks5CommandResponseDecoder(Socks5AddressDecoder addressDecoder)

Method Summary

Modifier and TypeMethod and Description
protected void
decode(ChannelHandlerContext
the ChannelHandlerContext which this ByteToMessageDecoder belongs to
ctx, Buffer
the Buffer from which to read data
in)

Implements abstract io.netty5.handler.codec.ByteToMessageDecoder.decode.

Decode the from one Buffer to another.
private void
fail(ChannelHandlerContext ctx, Exception cause)

Inherited from io.netty5.handler.codec.ByteToMessageDecoder:
actualReadableByteschannelInactivechannelReadchannelReadCompletechannelShutdowndecodeLastdiscardSomeReadByteshandlerAddedhandlerAdded0handlerRemovedhandlerRemoved0internalBufferisSharableisSingleDecodesetSingleDecode

Field Detail

addressDecoderback to summary
private final Socks5AddressDecoder addressDecoder
stateback to summary
private Socks5CommandResponseDecoder.State state

Constructor Detail

Socks5CommandResponseDecoderback to summary
public Socks5CommandResponseDecoder()
Socks5CommandResponseDecoderback to summary
public Socks5CommandResponseDecoder(Socks5AddressDecoder addressDecoder)

Method Detail

decodeback to summary
protected void decode(ChannelHandlerContext ctx, Buffer in) throws Exception

Implements abstract io.netty5.handler.codec.ByteToMessageDecoder.decode.

Doc from io.netty5.handler.codec.ByteToMessageDecoder.decode.

Decode the from one Buffer to another. This method will be called till either the input Buffer has nothing to read when return from this method or till nothing was read from the input Buffer.

Parameters
ctx:ChannelHandlerContext

the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in:Buffer

the Buffer from which to read data

Annotations
@Override
Exceptions
Exception:
is thrown if an error occurs
failback to summary
private void fail(ChannelHandlerContext ctx, Exception cause)
io.netty.contrib.handler.codec.socksx.v5 back to summary

private final Enum Socks5CommandResponseDecoder.State

extends Enum<Socks5CommandResponseDecoder.State>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final Socks5CommandResponseDecoder.State
FAILURE

public static final Socks5CommandResponseDecoder.State
INIT

public static final Socks5CommandResponseDecoder.State
SUCCESS

Constructor Summary

AccessConstructor and Description
private
State()

Method Summary

Modifier and TypeMethod and Description
public static Socks5CommandResponseDecoder.State
valueOf(String name)

public static Socks5CommandResponseDecoder.State[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

FAILUREback to summary
public static final Socks5CommandResponseDecoder.State FAILURE
INITback to summary
public static final Socks5CommandResponseDecoder.State INIT
SUCCESSback to summary
public static final Socks5CommandResponseDecoder.State SUCCESS

Constructor Detail

Stateback to summary
private State()

Method Detail

valueOfback to summary
public static Socks5CommandResponseDecoder.State valueOf(String name)
valuesback to summary
public static Socks5CommandResponseDecoder.State[] values()