Netty/Codec/Socks Proxy Parent 5.0.0.Alpha2 · io.netty.contrib.handler.proxy.ProxyHandler

Modifier and Type	Class and Description
private class	ProxyHandler.LazyPromise

Modifier and Type	Field and Description
pack-priv static final String	AUTH_NONE A string that signifies 'no authentication' or 'anonymous'.
private final Promise<Channel>	connectPromise
private Future<?>	connectTimeoutFuture
private volatile long	connectTimeoutMillis
private volatile ChannelHandlerContext	ctx
private static final long	DEFAULT_CONNECT_TIMEOUT_MILLIS The default connect timeout: 10 seconds.
private volatile SocketAddress	destinationAddress
private boolean	finished
private boolean	flushedPrematurely
private static final InternalLogger	logger
private PendingWriteQueue	pendingWrites
private final SocketAddress	proxyAddress
private boolean	suppressChannelReadComplete
private final FutureListener<Void>	writeListener

Access	Constructor and Description
protected	ProxyHandler(SocketAddress proxyAddress)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addCodec(ChannelHandlerContext ctx) Adds the codec handlers required to communicate with the proxy server.
private void	addPendingWrite(ChannelHandlerContext ctx, Object msg, Promise<Void> promise)
public abstract String	authScheme() Returns the name of the authentication scheme in use.
private void	cancelConnectTimeoutFuture()
public final void	channelActive(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelActive. The `Channel` of the `ChannelHandlerContext` is now active
public final void	channelExceptionCaught(ChannelHandlerContext ctx, Throwable cause) Overrides default io.netty5.channel.ChannelHandler.channelExceptionCaught. Gets called if a `Throwable` was thrown when handling inbound events.
public final void	channelInactive(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime.
public final void	channelRead(ChannelHandlerContext ctx, Object msg) Overrides default io.netty5.channel.ChannelHandler.channelRead. Invoked when the current `Channel` has read a message from the peer.
public final void	channelReadComplete(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`.
public final Future<Void>	connect(ChannelHandlerContext the `ChannelHandlerContext` for which the connect operation is made ctx, SocketAddress the `SocketAddress` to which it should connect remoteAddress, SocketAddress the `SocketAddress` which is used as source on connect localAddress) Overrides default io.netty5.channel.ChannelHandler.connect. Called once a connect operation is made.
public final Future<Channel>	connectFuture() Returns a `Future` that is notified when the connection to the destination has been established or the connection attempt has failed.
public final long	connectTimeoutMillis() Returns the connect timeout in millis.
public final <T extends SocketAddress> T	destinationAddress() Returns the address of the destination to connect to via the proxy server.
protected final String	exceptionMessage(String msg) Decorates the specified exception message with the common information such as the current protocol, authentication scheme, proxy address, and destination address.
private void	failPendingWrites(Throwable cause)
private void	failPendingWritesAndClose(Throwable cause)
public final void	flush(ChannelHandlerContext the `ChannelHandlerContext` for which the flush operation is made ctx) Overrides default io.netty5.channel.ChannelHandler.flush. Called once a flush operation is made.
public final void	handlerAdded(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
protected abstract boolean	Returns: `true` if the connection to the destination has been established, `false` if the connection to the destination has not been established and more messages are expected from the proxy server handleResponse(ChannelHandlerContext ctx, Object response) Handles the message received from the proxy server.
public final boolean	isConnected() Returns `true` if and only if the connection to the destination has been established successfully.
protected abstract Object	Returns: the initial message, or `null` if the proxy server is expected to send the first message instead newInitialMessage(ChannelHandlerContext ctx) Returns a new message that is sent at first time when the connection to the proxy server has been established.
public abstract String	protocol() Returns the name of the proxy protocol in use.
public final <T extends SocketAddress> T	proxyAddress() Returns the address of the proxy server.
private static void	readIfNeeded(ChannelHandlerContext ctx)
protected abstract void	removeDecoder(ChannelHandlerContext ctx) Removes the decoders added in `addCodec(ChannelHandlerContext)`.
protected abstract void	removeEncoder(ChannelHandlerContext ctx) Removes the encoders added in `addCodec(ChannelHandlerContext)`.
private boolean	safeRemoveDecoder()
private boolean	safeRemoveEncoder()
private void	sendInitialMessage(final ChannelHandlerContext ctx) Sends the initial message to be sent to the proxy server.
protected final void	sendToProxyServer(Object msg) Sends the specified message to the proxy server.
private void	setConnectFailure(Throwable cause)
private void	setConnectSuccess(ChannelHandlerContext ctx)
public final void	setConnectTimeoutMillis(long connectTimeoutMillis) Sets the connect timeout in millis.
public final Future<Void>	write(ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg) Overrides default io.netty5.channel.ChannelHandler.write. Called once a write operation is made.
private void	writePendingWrites(ChannelHandlerContext ctx)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

AUTH_NONE	back to summary
pack-priv static final String AUTH_NONE A string that signifies 'no authentication' or 'anonymous'.

connectPromise	back to summary
private final Promise<Channel> connectPromise

connectTimeoutFuture	back to summary
private Future<?> connectTimeoutFuture

connectTimeoutMillis	back to summary
private volatile long connectTimeoutMillis

ctx	back to summary
private volatile ChannelHandlerContext ctx

DEFAULT_CONNECT_TIMEOUT_MILLIS	back to summary
private static final long DEFAULT_CONNECT_TIMEOUT_MILLIS The default connect timeout: 10 seconds.

destinationAddress	back to summary
private volatile SocketAddress destinationAddress

finished	back to summary
private boolean finished

flushedPrematurely	back to summary
private boolean flushedPrematurely

logger	back to summary
private static final InternalLogger logger

pendingWrites	back to summary
private PendingWriteQueue pendingWrites

proxyAddress	back to summary
private final SocketAddress proxyAddress

suppressChannelReadComplete	back to summary
private boolean suppressChannelReadComplete

writeListener	back to summary
private final FutureListener<Void> writeListener

ProxyHandler	back to summary
protected ProxyHandler(SocketAddress proxyAddress)

Method Detail

addCodec	back to summary
protected abstract void addCodec(ChannelHandlerContext ctx) throws Exception Adds the codec handlers required to communicate with the proxy server.

addPendingWrite	back to summary
private void addPendingWrite(ChannelHandlerContext ctx, Object msg, Promise<Void> promise)

authScheme	back to summary
public abstract String authScheme() Returns the name of the authentication scheme in use.

cancelConnectTimeoutFuture	back to summary
private void cancelConnectTimeoutFuture()

channelActive back to summary

channelActive	back to summary
public final void channelActive(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelActive. Doc from io.netty5.channel.ChannelHandler.channelActive. The `Channel` of the `ChannelHandlerContext` is now active Annotations @Override

public final void channelActive(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelActive.

Doc from io.netty5.channel.ChannelHandler.channelActive.

The Channel of the ChannelHandlerContext is now active

Annotations

@Override

channelExceptionCaught back to summary

channelExceptionCaught	back to summary
public final void channelExceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelExceptionCaught. Doc from io.netty5.channel.ChannelHandler.channelExceptionCaught. Gets called if a `Throwable` was thrown when handling inbound events. Annotations @Override

public final void channelExceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelExceptionCaught.

Doc from io.netty5.channel.ChannelHandler.channelExceptionCaught.

Gets called if a Throwable was thrown when handling inbound events.

Annotations

@Override

channelInactive back to summary

channelInactive	back to summary
public final void channelInactive(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelInactive. Doc from io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime. Annotations @Override

public final void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelInactive.

Doc from io.netty5.channel.ChannelHandler.channelInactive.

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Annotations

@Override

channelRead back to summary

channelRead	back to summary
public final void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelRead. Doc from io.netty5.channel.ChannelHandler.channelRead. Invoked when the current `Channel` has read a message from the peer. Annotations @Override

public final void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelRead.

Doc from io.netty5.channel.ChannelHandler.channelRead.

Invoked when the current Channel has read a message from the peer.

Annotations

@Override

channelReadComplete back to summary

channelReadComplete	back to summary
public final void channelReadComplete(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Doc from io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`. If `ChannelOption#AUTO_READ` is off, no further attempt to read an inbound data from the current `Channel` will be made until `ChannelOutboundInvoker#read(ReadBufferAllocator)` is called. Annotations @Override

public final void channelReadComplete(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelReadComplete.

Doc from io.netty5.channel.ChannelHandler.channelReadComplete.

Invoked when the last message read by the current read operation has been consumed by channelRead(ChannelHandlerContext, Object). If ChannelOption#AUTO_READ is off, no further attempt to read an inbound data from the current Channel will be made until ChannelOutboundInvoker#read(ReadBufferAllocator) is called.

Annotations

@Override

connect back to summary

connect	back to summary
public final Future<Void> connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress) Overrides default io.netty5.channel.ChannelHandler.connect. Doc from io.netty5.channel.ChannelHandler.connect. Called once a connect operation is made. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the connect operation is made remoteAddress:SocketAddress the `SocketAddress` to which it should connect localAddress:SocketAddress the `SocketAddress` which is used as source on connect Returns:Future<Void> the `Future` which will be notified once the operation completes. Annotations @Override

public final Future<Void> connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress)

Overrides default io.netty5.channel.ChannelHandler.connect.

Doc from io.netty5.channel.ChannelHandler.connect.

Called once a connect operation is made.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the connect operation is made
remoteAddress:SocketAddress: the SocketAddress to which it should connect
localAddress:SocketAddress: the SocketAddress which is used as source on connect

Returns:Future<Void>

the Future which will be notified once the operation completes.

Annotations

@Override

connectFuture	back to summary
public final Future<Channel> connectFuture() Returns a `Future` that is notified when the connection to the destination has been established or the connection attempt has failed.

connectTimeoutMillis	back to summary
public final long connectTimeoutMillis() Returns the connect timeout in millis. If the connection attempt to the destination does not finish within the timeout, the connection attempt will be failed.

destinationAddress	back to summary
public final <T extends SocketAddress> T destinationAddress() Returns the address of the destination to connect to via the proxy server. Annotations @SuppressWarnings:unchecked

destinationAddress

back to summary

public final <T extends SocketAddress> T destinationAddress()

Returns the address of the destination to connect to via the proxy server.

Annotations

@SuppressWarnings:unchecked

exceptionMessage	back to summary
protected final String exceptionMessage(String msg) Decorates the specified exception message with the common information such as the current protocol, authentication scheme, proxy address, and destination address.

failPendingWrites	back to summary
private void failPendingWrites(Throwable cause)

failPendingWritesAndClose	back to summary
private void failPendingWritesAndClose(Throwable cause)

flush back to summary

flush	back to summary
public final void flush(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.flush. Doc from io.netty5.channel.ChannelHandler.flush. Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the flush operation is made Annotations @Override

public final void flush(ChannelHandlerContext ctx)

Overrides default io.netty5.channel.ChannelHandler.flush.

Doc from io.netty5.channel.ChannelHandler.flush.

Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the flush operation is made

Annotations

@Override

handlerAdded back to summary

handlerAdded	back to summary
public final void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.handlerAdded. Doc from io.netty5.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public final void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.handlerAdded.

Doc from io.netty5.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

handleResponse back to summary

handleResponse	back to summary
protected abstract boolean handleResponse(ChannelHandlerContext ctx, Object response) throws Exception Handles the message received from the proxy server. Returns:boolean `true` if the connection to the destination has been established, `false` if the connection to the destination has not been established and more messages are expected from the proxy server

protected abstract boolean handleResponse(ChannelHandlerContext ctx, Object response) throws Exception

Handles the message received from the proxy server.

Returns:boolean: true if the connection to the destination has been established, false if the connection to the destination has not been established and more messages are expected from the proxy server

isConnected	back to summary
public final boolean isConnected() Returns `true` if and only if the connection to the destination has been established successfully.

newInitialMessage back to summary

newInitialMessage	back to summary
protected abstract Object newInitialMessage(ChannelHandlerContext ctx) throws Exception Returns a new message that is sent at first time when the connection to the proxy server has been established. Returns:Object the initial message, or `null` if the proxy server is expected to send the first message instead

protected abstract Object newInitialMessage(ChannelHandlerContext ctx) throws Exception

Returns a new message that is sent at first time when the connection to the proxy server has been established.

Returns:Object: the initial message, or null if the proxy server is expected to send the first message instead

protocol	back to summary
public abstract String protocol() Returns the name of the proxy protocol in use.

proxyAddress	back to summary
public final <T extends SocketAddress> T proxyAddress() Returns the address of the proxy server. Annotations @SuppressWarnings:unchecked

proxyAddress

back to summary

public final <T extends SocketAddress> T proxyAddress()

Returns the address of the proxy server.

Annotations

@SuppressWarnings:unchecked

readIfNeeded	back to summary
private static void readIfNeeded(ChannelHandlerContext ctx)

removeDecoder	back to summary
protected abstract void removeDecoder(ChannelHandlerContext ctx) throws Exception Removes the decoders added in `addCodec(ChannelHandlerContext)`.

removeEncoder	back to summary
protected abstract void removeEncoder(ChannelHandlerContext ctx) throws Exception Removes the encoders added in `addCodec(ChannelHandlerContext)`.

safeRemoveDecoder	back to summary
private boolean safeRemoveDecoder()

safeRemoveEncoder	back to summary
private boolean safeRemoveEncoder()

sendInitialMessage	back to summary
private void sendInitialMessage(final ChannelHandlerContext ctx) throws Exception Sends the initial message to be sent to the proxy server. This method also starts a timeout task which marks the `connectPromise` as failure if the connection attempt does not success within the timeout.

sendToProxyServer	back to summary
protected final void sendToProxyServer(Object msg) Sends the specified message to the proxy server. Use this method to send a response to the proxy server in `handleResponse(ChannelHandlerContext, Object)`.

setConnectFailure	back to summary
private void setConnectFailure(Throwable cause)

setConnectSuccess	back to summary
private void setConnectSuccess(ChannelHandlerContext ctx)

setConnectTimeoutMillis	back to summary
public final void setConnectTimeoutMillis(long connectTimeoutMillis) Sets the connect timeout in millis. If the connection attempt to the destination does not finish within the timeout, the connection attempt will be failed.

write back to summary

public final Future<Void> write(ChannelHandlerContext ctx, Object msg)

Overrides default io.netty5.channel.ChannelHandler.write.

Doc from io.netty5.channel.ChannelHandler.write.

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel#flush() is called.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the write operation is made
msg:Object: the message to write

Returns:Future<Void>

the Future which will be notified once the operation completes.

Annotations

@Override

writePendingWrites	back to summary
private void writePendingWrites(ChannelHandlerContext ctx)

public abstract Class ProxyHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ProxyHandler.LazyPromise

Constructor Summary

Method Summary

Constructor Detail

Method Detail