Class Socks5PrivateAuthResponseDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.socksx.v5.Socks5PrivateAuthResponseDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public final class Socks5PrivateAuthResponseDecoder
extends ByteToMessageDecoder

Decodes a single Socks5PrivateAuthResponse from the inbound ByteBufs. 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.

The default format follows a simple structure:

• 1 byte: version (must be 1)
• 1 byte: status (0x00 for success, 0xFF for failure)

For custom private authentication protocols, you can:

• Create a new decoder implementing ByteToMessageDecoder or similar
• Implement the Socks5PrivateAuthResponse interface or extend DefaultSocks5PrivateAuthResponse
• Create a custom handler chain to process the authentication responses

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	Socks5PrivateAuthResponseDecoder.State	Decoder states for SOCKS5 private authentication responses.

Nested classes/interfaces inherited from class ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private Socks5PrivateAuthResponseDecoder.State	state

Fields inherited from class ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
Socks5PrivateAuthResponseDecoder()

Method Summary

Modifier and Type	Method	Description
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)	Decode the from one ByteBuf to an other.
private void	fail(java.util.List<java.lang.Object> out, java.lang.Exception cause)	Handles decoder failures by setting the appropriate error state.

Methods inherited from class ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface ChannelHandler

handlerAdded

Field Details

state

private Socks5PrivateAuthResponseDecoder.State state

Constructor Details

Socks5PrivateAuthResponseDecoder

public Socks5PrivateAuthResponseDecoder()

Method Details

decode

protected void decode(ChannelHandlerContext ctx,
 ByteBuf in,
 java.util.List<java.lang.Object> out)
               throws java.lang.Exception

Description copied from class: ByteToMessageDecoder

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

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

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

fail

private void fail(java.util.List<java.lang.Object> out,
 java.lang.Exception cause)

Handles decoder failures by setting the appropriate error state.

Parameters:

out - the output list to add the failure message to

cause - the exception that caused the failure