org.jboss.netty.handler.codec.socks

Class SocksMessage

java.lang.Object

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

Direct Known Subclasses:

SocksRequest, SocksResponse, UnknownSocksMessage

public abstract class SocksMessage
extends java.lang.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 and Description
static class	SocksMessage.AddressType
static class	SocksMessage.AuthScheme
static class	SocksMessage.AuthStatus
static class	SocksMessage.CmdStatus
static class	SocksMessage.CmdType
static class	SocksMessage.MessageType
static class	SocksMessage.ProtocolVersion
static class	SocksMessage.SubnegotiationVersion

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SocksMessage(SocksMessage.MessageType messageType)

Method Summary

Modifier and Type	Method and 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 java.lang.Object

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

Field Detail

messageType

private final SocksMessage.MessageType messageType

protocolVersion

private final SocksMessage.ProtocolVersion protocolVersion

Constructor Detail

SocksMessage

protected SocksMessage(SocksMessage.MessageType messageType)

Method Detail

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 java.lang.Exception

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

Throws:

java.lang.Exception

See Also:

ChannelBuffer