Modifier and Type	Class and Description
public static enum	ProxyConnectionPool.AvailabilityType
private static class	ProxyConnectionPool.CallbackHolder
private static class	ProxyConnectionPool.ConnectionHolder
private class	ProxyConnectionPool.HostThreadData

Field Summary

Modifier and Type	Field and Description
private final InetSocketAddress	bindAddress
private final UndertowClient	client
private volatile boolean	closed Set to true when the connection pool is closed.
private final ConnectionPoolManager	connectionPoolManager
private final int	coreCachedConnections The minimum number of connections that this proxy connection pool will try and keep established.
private final ConcurrentMap<XnioIoThread, ProxyConnectionPool.HostThreadData>	hostThreadData
private final int	maxCachedConnections The maximum number of connections that will be kept alive once they are idle.
private final int	maxConnections The maximum number of connections that can be established to the target
private final AtomicInteger	openConnections The total number of open connections, across all threads
private final OptionMap	options
private final AtomicLong	read read bytes for all closed connections
private final AtomicLong	requestCount request count for all closed connections
private final XnioSsl	ssl
private final long	timeToLive The timeout for idle connections.
private final URI	uri
private final AtomicLong	written written bytes for all closed connections

Constructor Summary

Access	Constructor and Description
public	ProxyConnectionPool(ConnectionPoolManager connectionPoolManager, URI uri, UndertowClient client, OptionMap options)
public	ProxyConnectionPool(ConnectionPoolManager connectionPoolManager, InetSocketAddress bindAddress, URI uri, UndertowClient client, OptionMap options)
public	ProxyConnectionPool(ConnectionPoolManager connectionPoolManager, URI uri, XnioSsl ssl, UndertowClient client, OptionMap options)
public	ProxyConnectionPool(ConnectionPoolManager connectionPoolManager, InetSocketAddress bindAddress, URI uri, XnioSsl ssl, UndertowClient client, OptionMap options)

Method Summary

Modifier and Type	Method and Description
public ProxyConnectionPool.AvailabilityType	available()
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
pack-priv void	closeCurrentConnections() Should only be used for tests.
public void	connect(ProxyClient.ProxyTarget proxyTarget, HttpServerExchange exchange, ProxyCallback<ProxyConnection> callback, final long timeout, final TimeUnit timeUnit, boolean - Is connection for the exclusive use of one client? exclusive)
private void	connectionReady(final ProxyConnectionPool.ConnectionHolder result, final ProxyCallback<ProxyConnection> callback, final HttpServerExchange exchange, final boolean exclusive)
public InetSocketAddress	getBindAddress()
public ClientStatistics	getClientStatistics()
private ProxyConnectionPool.HostThreadData	Returns: The data for this thread getData() Gets the host data for this thread
public int	Returns: The total number of open connections getOpenConnections()
public URI	getUri()
private void	handleClosedConnection(ProxyConnectionPool.HostThreadData hostData, final ProxyConnectionPool.ConnectionHolder connection)
private void	openConnection(final HttpServerExchange exchange, final ProxyCallback<ProxyConnection> callback, final ProxyConnectionPool.HostThreadData data, final boolean exclusive)
private void	redistributeQueued(ProxyConnectionPool.HostThreadData hostData)
private void	returnConnection(final ProxyConnectionPool.ConnectionHolder The client connection holder connectionHolder) Called when the IO thread has completed a successful request
private void	scheduleFailedHostRetry(final HttpServerExchange The server exchange exchange) If a host fails we periodically retry
private void	timeoutConnections(final long the current time currentTime, final ProxyConnectionPool.HostThreadData the local host thread data data) Timeout idle connections which are above the soft max cached connections limit.

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

Field Detail

bindAddress	back to summary
private final InetSocketAddress bindAddress

client	back to summary
private final UndertowClient client

closed	back to summary
private volatile boolean closed Set to true when the connection pool is closed.

connectionPoolManager	back to summary
private final ConnectionPoolManager connectionPoolManager

coreCachedConnections	back to summary
private final int coreCachedConnections The minimum number of connections that this proxy connection pool will try and keep established. Once the pool is down to this number of connections no more connections will be timed out. Note This value is per IO thread, so to get the actual value this must be multiplied by the number of IO threads

hostThreadData	back to summary
private final ConcurrentMap<XnioIoThread, ProxyConnectionPool.HostThreadData> hostThreadData

maxCachedConnections	back to summary
private final int maxCachedConnections The maximum number of connections that will be kept alive once they are idle. If a time to live is set these connections may be timed out, depending on the value of `coreCachedConnections`. Note This value is per IO thread, so to get the actual value this must be multiplied by the number of IO threads

maxConnections	back to summary
private final int maxConnections The maximum number of connections that can be established to the target

openConnections	back to summary
private final AtomicInteger openConnections The total number of open connections, across all threads

options	back to summary
private final OptionMap options

read	back to summary
private final AtomicLong read read bytes for all closed connections

requestCount	back to summary
private final AtomicLong requestCount request count for all closed connections

ssl	back to summary
private final XnioSsl ssl

timeToLive	back to summary
private final long timeToLive The timeout for idle connections. Note that if `#coreCachedConnections` is set then once the pool is down to the core size no more connections will be timed out.

uri	back to summary
private final URI uri

written	back to summary
private final AtomicLong written written bytes for all closed connections

Constructor Detail

ProxyConnectionPool	back to summary
public ProxyConnectionPool(ConnectionPoolManager connectionPoolManager, URI uri, UndertowClient client, OptionMap options)

ProxyConnectionPool	back to summary
public ProxyConnectionPool(ConnectionPoolManager connectionPoolManager, InetSocketAddress bindAddress, URI uri, UndertowClient client, OptionMap options)

ProxyConnectionPool	back to summary
public ProxyConnectionPool(ConnectionPoolManager connectionPoolManager, URI uri, XnioSsl ssl, UndertowClient client, OptionMap options)

ProxyConnectionPool	back to summary
public ProxyConnectionPool(ConnectionPoolManager connectionPoolManager, InetSocketAddress bindAddress, URI uri, XnioSsl ssl, UndertowClient client, OptionMap options)

Method Detail

available	back to summary
public ProxyConnectionPool.AvailabilityType available()

close back to summary

close	back to summary
public void close() Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`.

public void close()

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

closeCurrentConnections	back to summary
pack-priv void closeCurrentConnections() Should only be used for tests.

connect	back to summary
public void connect(ProxyClient.ProxyTarget proxyTarget, HttpServerExchange exchange, ProxyCallback<ProxyConnection> callback, final long timeout, final TimeUnit timeUnit, boolean exclusive) Parameters exclusive:boolean - Is connection for the exclusive use of one client?

connectionReady	back to summary
private void connectionReady(final ProxyConnectionPool.ConnectionHolder result, final ProxyCallback<ProxyConnection> callback, final HttpServerExchange exchange, final boolean exclusive)

getBindAddress	back to summary
public InetSocketAddress getBindAddress()

getClientStatistics	back to summary
public ClientStatistics getClientStatistics()

getData	back to summary
private ProxyConnectionPool.HostThreadData getData() Gets the host data for this thread Returns:ProxyConnectionPool.HostThreadData The data for this thread

getData

back to summary

private ProxyConnectionPool.HostThreadData getData()

Gets the host data for this thread

Returns:ProxyConnectionPool.HostThreadData: The data for this thread

getOpenConnections	back to summary
public int getOpenConnections() Returns:int The total number of open connections

getUri	back to summary
public URI getUri()

handleClosedConnection	back to summary
private void handleClosedConnection(ProxyConnectionPool.HostThreadData hostData, final ProxyConnectionPool.ConnectionHolder connection)

openConnection	back to summary
private void openConnection(final HttpServerExchange exchange, final ProxyCallback<ProxyConnection> callback, final ProxyConnectionPool.HostThreadData data, final boolean exclusive)

redistributeQueued	back to summary
private void redistributeQueued(ProxyConnectionPool.HostThreadData hostData)

returnConnection	back to summary
private void returnConnection(final ProxyConnectionPool.ConnectionHolder connectionHolder) Called when the IO thread has completed a successful request Parameters connectionHolder:ProxyConnectionPool.ConnectionHolder The client connection holder

returnConnection

back to summary

private void returnConnection(final ProxyConnectionPool.ConnectionHolder connectionHolder)

Called when the IO thread has completed a successful request

Parameters

connectionHolder:ProxyConnectionPool.ConnectionHolder: The client connection holder

scheduleFailedHostRetry	back to summary
private void scheduleFailedHostRetry(final HttpServerExchange exchange) If a host fails we periodically retry Parameters exchange:HttpServerExchange The server exchange

scheduleFailedHostRetry

back to summary

private void scheduleFailedHostRetry(final HttpServerExchange exchange)

If a host fails we periodically retry

Parameters

exchange:HttpServerExchange: The server exchange

timeoutConnections	back to summary
private void timeoutConnections(final long currentTime, final ProxyConnectionPool.HostThreadData data) Timeout idle connections which are above the soft max cached connections limit. Parameters currentTime:long the current time data:ProxyConnectionPool.HostThreadData the local host thread data

timeoutConnections

back to summary

private void timeoutConnections(final long currentTime, final ProxyConnectionPool.HostThreadData data)

Timeout idle connections which are above the soft max cached connections limit.

Parameters

currentTime:long: the current time
data:ProxyConnectionPool.HostThreadData: the local host thread data

io.undertow.server.handlers.proxy back to summary

public final Enum ProxyConnectionPool.AvailabilityType

Class Inheritance

extends Enum<ProxyConnectionPool.AvailabilityType>

java.lang.Object
java.lang.Enum
io.undertow.server.handlers.proxy.ProxyConnectionPool.AvailabilityType

Field Summary

Modifier and Type	Field and Description
public static final ProxyConnectionPool.AvailabilityType	AVAILABLE The host is read to accept requests
public static final ProxyConnectionPool.AvailabilityType	CLOSED The host is closed.
public static final ProxyConnectionPool.AvailabilityType	DRAIN The host is stopped.
public static final ProxyConnectionPool.AvailabilityType	FULL All connections are in use, connections will be queued
public static final ProxyConnectionPool.AvailabilityType	FULL_QUEUE All connections are in use and the queue is full.
public static final ProxyConnectionPool.AvailabilityType	PROBLEM The host is probably down, only try as a last resort

Constructor Summary

Access	Constructor and Description
private	AvailabilityType()

Method Summary

Modifier and Type	Method and Description
public static ProxyConnectionPool.AvailabilityType	valueOf(String name)
public static ProxyConnectionPool.AvailabilityType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

AVAILABLE	back to summary
public static final ProxyConnectionPool.AvailabilityType AVAILABLE The host is read to accept requests

CLOSED	back to summary
public static final ProxyConnectionPool.AvailabilityType CLOSED The host is closed. connections will always fail

DRAIN	back to summary
public static final ProxyConnectionPool.AvailabilityType DRAIN The host is stopped. No request should be forwarded that are not tied to this node via sticky sessions

FULL	back to summary
public static final ProxyConnectionPool.AvailabilityType FULL All connections are in use, connections will be queued

FULL_QUEUE	back to summary
public static final ProxyConnectionPool.AvailabilityType FULL_QUEUE All connections are in use and the queue is full. Requests will be rejected.

PROBLEM	back to summary
public static final ProxyConnectionPool.AvailabilityType PROBLEM The host is probably down, only try as a last resort

Constructor Detail

AvailabilityType	back to summary
private AvailabilityType()

Method Detail

valueOf	back to summary
public static ProxyConnectionPool.AvailabilityType valueOf(String name)

values	back to summary
public static ProxyConnectionPool.AvailabilityType[] values()

io.undertow.server.handlers.proxy back to summary

private final Class ProxyConnectionPool.CallbackHolder

Class Inheritance

extends Object
implements Runnable

java.lang.Object
io.undertow.server.handlers.proxy.ProxyConnectionPool.CallbackHolder

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
pack-priv final ProxyCallback<ProxyConnection>	callback
pack-priv boolean	cancelled
pack-priv final HttpServerExchange	exchange
pack-priv final long	expireTime
pack-priv final ProxyClient.ProxyTarget	proxyTarget
pack-priv XnioExecutor.Key	timeoutKey

Constructor Summary

Access	Constructor and Description
private	CallbackHolder(ProxyClient.ProxyTarget proxyTarget, ProxyCallback<ProxyConnection> callback, HttpServerExchange exchange, long expireTime)

Method Summary

Modifier and Type	Method and Description
private ProxyCallback<ProxyConnection>	getCallback()
private HttpServerExchange	getExchange()
private long	getExpireTime()
public ProxyClient.ProxyTarget	getProxyTarget()
private XnioExecutor.Key	getTimeoutKey()
private boolean	isCancelled()
public void	run() Implements java.lang.Runnable.run. Runs this operation.
private void	setTimeoutKey(XnioExecutor.Key timeoutKey)

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

Field Detail

callback	back to summary
pack-priv final ProxyCallback<ProxyConnection> callback

cancelled	back to summary
pack-priv boolean cancelled

exchange	back to summary
pack-priv final HttpServerExchange exchange

expireTime	back to summary
pack-priv final long expireTime

proxyTarget	back to summary
pack-priv final ProxyClient.ProxyTarget proxyTarget

timeoutKey	back to summary
pack-priv XnioExecutor.Key timeoutKey

Constructor Detail

CallbackHolder	back to summary
private CallbackHolder(ProxyClient.ProxyTarget proxyTarget, ProxyCallback<ProxyConnection> callback, HttpServerExchange exchange, long expireTime)

Method Detail

getCallback	back to summary
private ProxyCallback<ProxyConnection> getCallback()

getExchange	back to summary
private HttpServerExchange getExchange()

getExpireTime	back to summary
private long getExpireTime()

getProxyTarget	back to summary
public ProxyClient.ProxyTarget getProxyTarget()

getTimeoutKey	back to summary
private XnioExecutor.Key getTimeoutKey()

isCancelled	back to summary
private boolean isCancelled()

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

setTimeoutKey	back to summary
private void setTimeoutKey(XnioExecutor.Key timeoutKey)

io.undertow.server.handlers.proxy back to summary

private final Class ProxyConnectionPool.ConnectionHolder

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.handlers.proxy.ProxyConnectionPool.ConnectionHolder

Field Summary

Modifier and Type	Field and Description
private final ClientConnection	clientConnection
private long	timeout

Constructor Summary

Access	Constructor and Description
private	ConnectionHolder(ClientConnection clientConnection)

Method Summary

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

Field Detail

clientConnection	back to summary
private final ClientConnection clientConnection

timeout	back to summary
private long timeout

Constructor Detail

ConnectionHolder	back to summary
private ConnectionHolder(ClientConnection clientConnection)

io.undertow.server.handlers.proxy back to summary

private final Class ProxyConnectionPool.HostThreadData

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.handlers.proxy.ProxyConnectionPool.HostThreadData

Field Summary

Modifier and Type	Field and Description
pack-priv final Deque<ProxyConnectionPool.ConnectionHolder>	availableConnections
pack-priv final Deque<ProxyConnectionPool.CallbackHolder>	awaitingConnections
pack-priv int	connections
pack-priv long	nextTimeout
pack-priv XnioExecutor.Key	timeoutKey
pack-priv final Runnable	timeoutTask

Constructor Summary

Access	Constructor and Description
private	HostThreadData()

Method Summary

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

Field Detail

availableConnections	back to summary
pack-priv final Deque<ProxyConnectionPool.ConnectionHolder> availableConnections

awaitingConnections	back to summary
pack-priv final Deque<ProxyConnectionPool.CallbackHolder> awaitingConnections

connections	back to summary
pack-priv int connections

nextTimeout	back to summary
pack-priv long nextTimeout

timeoutKey	back to summary
pack-priv XnioExecutor.Key timeoutKey

timeoutTask	back to summary
pack-priv final Runnable timeoutTask

Constructor Detail

HostThreadData	back to summary
private HostThreadData()

public Class ProxyConnectionPool

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ProxyConnectionPool.AvailabilityType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ProxyConnectionPool.CallbackHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ProxyConnectionPool.ConnectionHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private final Class ProxyConnectionPool.HostThreadData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail