Top Description Fields Constructors Methods
io.netty.contrib.handler.codec.socks

public final Class SocksCmdResponse

extends SocksResponse
Class Inheritance
Imports
io.netty5.buffer.Buffer, java.nio.charset.StandardCharsets, io.netty5.util.NetUtil, java.net.IDN
A socks cmd response.
See Also
SocksCmdRequest, SocksCmdResponseDecoder

Field Summary

Modifier and TypeField and Description
private final SocksAddressType
addressType

private final SocksCmdStatus
cmdStatus

private static final byte[]
DOMAIN_ZEROED

private final String
host

private static final byte[]
IPv4_HOSTNAME_ZEROED

private static final byte[]
IPv6_HOSTNAME_ZEROED

private final int
port

Constructor Summary

AccessConstructor and Description
public
SocksCmdResponse(SocksCmdStatus cmdStatus, SocksAddressType addressType)

public
SocksCmdResponse(SocksCmdStatus
status of the response
cmdStatus, SocksAddressType
type of host parameter
addressType, String
host (BND.ADDR field) is address that server used when connecting to the target host. When null a value of 4/8 0x00 octets will be used for IPv4/IPv6 and a single 0x00 byte will be used for domain addressType. Value is converted to ASCII using IDN#toASCII(String).
host, int
port (BND.PORT field) that the server assigned to connect to the target host
port)

Constructs new response and includes provided host and port as part of it.

Method Summary

Modifier and TypeMethod and Description
public SocksAddressType

Returns:

The SocksAddressType of this SocksCmdResponse
addressType()

Returns the SocksAddressType of this SocksCmdResponse

public SocksCmdStatus

Returns:

The SocksCmdStatus of this SocksCmdResponse
cmdStatus()

Returns the SocksCmdStatus of this SocksCmdResponse

public void
encodeAsBuffer(Buffer buffer)

Implements abstract io.netty.contrib.handler.codec.socks.SocksMessage.encodeAsBuffer.

public String

Returns:

host that is used as a parameter in SocksCmdType or null when there was no host specified during response construction
host()

Returns host that is used as a parameter in SocksCmdType.

public int

Returns:

port that is used as a parameter in SocksCmdType
port()

Returns port that is used as a parameter in SocksCmdType.

Inherited from io.netty.contrib.handler.codec.socks.SocksResponse:
responseType

Field Detail

addressTypeback to summary
private final SocksAddressType addressType
cmdStatusback to summary
private final SocksCmdStatus cmdStatus
DOMAIN_ZEROEDback to summary
private static final byte[] DOMAIN_ZEROED
hostback to summary
private final String host
IPv4_HOSTNAME_ZEROEDback to summary
private static final byte[] IPv4_HOSTNAME_ZEROED
IPv6_HOSTNAME_ZEROEDback to summary
private static final byte[] IPv6_HOSTNAME_ZEROED
portback to summary
private final int port

Constructor Detail

SocksCmdResponseback to summary
public SocksCmdResponse(SocksCmdStatus cmdStatus, SocksAddressType addressType)
SocksCmdResponseback to summary
public SocksCmdResponse(SocksCmdStatus cmdStatus, SocksAddressType addressType, String host, int port)

Constructs new response and includes provided host and port as part of it.

Parameters
cmdStatus:SocksCmdStatus

status of the response

addressType:SocksAddressType

type of host parameter

host:String

host (BND.ADDR field) is address that server used when connecting to the target host. When null a value of 4/8 0x00 octets will be used for IPv4/IPv6 and a single 0x00 byte will be used for domain addressType. Value is converted to ASCII using IDN#toASCII(String).

port:int

port (BND.PORT field) that the server assigned to connect to the target host

Exceptions
NullPointerException:
in case cmdStatus or addressType are missing
IllegalArgumentException:
in case host or port cannot be validated
See Also
IDN#toASCII(String)

Method Detail

addressTypeback to summary
public SocksAddressType addressType()

Returns the SocksAddressType of this SocksCmdResponse

Returns:SocksAddressType

The SocksAddressType of this SocksCmdResponse

cmdStatusback to summary
public SocksCmdStatus cmdStatus()

Returns the SocksCmdStatus of this SocksCmdResponse

Returns:SocksCmdStatus

The SocksCmdStatus of this SocksCmdResponse

encodeAsBufferback to summary
public void encodeAsBuffer(Buffer buffer)

Implements abstract io.netty.contrib.handler.codec.socks.SocksMessage.encodeAsBuffer.

Annotations
@Override
hostback to summary
public String host()

Returns host that is used as a parameter in SocksCmdType. Host (BND.ADDR field in response) is address that server used when connecting to the target host. This is typically different from address which client uses to connect to the SOCKS server.

Returns:String

host that is used as a parameter in SocksCmdType or null when there was no host specified during response construction

portback to summary
public int port()

Returns port that is used as a parameter in SocksCmdType. Port (BND.PORT field in response) is port that the server assigned to connect to the target host.

Returns:int

port that is used as a parameter in SocksCmdType