Class SocksMessage

java.lang.Object

org.jboss.netty.handler.codec.socks.SocksMessage

Direct Known Subclasses:

SocksRequest, SocksResponse, UnknownSocksMessage

public abstract class SocksMessage
extends Object

An abstract class that defines a SocksMessage, providing common properties for SocksRequest and SocksResponse.

See Also:

• SocksRequest
• SocksResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SocksMessage.AddressType
static enum	SocksMessage.AuthScheme
static enum	SocksMessage.AuthStatus
static enum	SocksMessage.CmdStatus
static enum	SocksMessage.CmdType
static enum	SocksMessage.MessageType
static enum	SocksMessage.ProtocolVersion
static enum	SocksMessage.SubnegotiationVersion

Field Summary

Fields

Modifier and Type	Field	Description
private final SocksMessage.MessageType	messageType
private final SocksMessage.ProtocolVersion	protocolVersion

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SocksMessage(SocksMessage.MessageType messageType)

Method Summary

Modifier and Type	Method	Description
abstract void	encodeAsByteBuf(ChannelBuffer channelBuffer)	Encode socks message into its byte representation and write it into byteBuf
SocksMessage.MessageType	getMessageType()	Returns the SocksMessage.MessageType of this SocksMessage
SocksMessage.ProtocolVersion	getProtocolVersion()	Returns the SocksMessage.ProtocolVersion of this SocksMessage

Methods inherited from class Object

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

Field Details

messageType

private final SocksMessage.MessageType messageType

protocolVersion

private final SocksMessage.ProtocolVersion protocolVersion

Constructor Details

SocksMessage

protected SocksMessage(SocksMessage.MessageType messageType)

Method Details

getMessageType

public SocksMessage.MessageType getMessageType()

Returns the SocksMessage.MessageType of this SocksMessage

Returns:

The SocksMessage.MessageType of this SocksMessage

getProtocolVersion

public SocksMessage.ProtocolVersion getProtocolVersion()

Returns the SocksMessage.ProtocolVersion of this SocksMessage

Returns:

The SocksMessage.ProtocolVersion of this SocksMessage

encodeAsByteBuf

public abstract void encodeAsByteBuf(ChannelBuffer channelBuffer)
                              throws Exception

Encode socks message into its byte representation and write it into byteBuf

Throws:

Exception

See Also:

• ChannelBuffer