org.littleshoot.proxy.impl

Class ServerGroup

java.lang.Object

org.littleshoot.proxy.impl.ServerGroup

public class ServerGroup
extends Object

Manages thread pools for one or more proxy server instances. When servers are created, they must register with the ServerGroup using registerProxyServer(HttpProxyServer), and when they shut down, must unregister with the ServerGroup using unregisterProxyServer(HttpProxyServer, boolean).

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INCOMING_ACCEPTOR_THREADS The default number of threads to accept incoming requests from clients.
static int	DEFAULT_INCOMING_WORKER_THREADS The default number of threads to service incoming requests from clients.
static int	DEFAULT_OUTGOING_WORKER_THREADS The default number of threads to service outgoing requests to servers.
List<HttpProxyServer>	registeredServers List of all servers registered to use this ServerGroup.

Constructor Summary

Constructors

Constructor and Description
ServerGroup(String name, int incomingAcceptorThreads, int incomingWorkerThreads, int outgoingWorkerThreads) Creates a new ServerGroup instance for a proxy.

Method Summary

Modifier and Type	Method and Description
io.netty.channel.EventLoopGroup	getClientToProxyAcceptorPoolForTransport(TransportProtocol protocol) Retrieves the client-to-proxy acceptor thread pool for the specified protocol.
io.netty.channel.EventLoopGroup	getClientToProxyWorkerPoolForTransport(TransportProtocol protocol) Retrieves the client-to-proxy acceptor worker pool for the specified protocol.
io.netty.channel.EventLoopGroup	getProxyToServerWorkerPoolForTransport(TransportProtocol protocol) Retrieves the proxy-to-server worker thread pool for the specified protocol.
boolean	isStopped()
void	registerProxyServer(HttpProxyServer proxyServer) Registers the specified proxy server as a consumer of this server group.
void	unregisterProxyServer(HttpProxyServer proxyServer, boolean graceful) Unregisters the specified proxy server from this server group.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INCOMING_ACCEPTOR_THREADS

public static final int DEFAULT_INCOMING_ACCEPTOR_THREADS

The default number of threads to accept incoming requests from clients. (Requests are serviced by worker threads, not acceptor threads.)

See Also:

Constant Field Values

DEFAULT_INCOMING_WORKER_THREADS

public static final int DEFAULT_INCOMING_WORKER_THREADS

The default number of threads to service incoming requests from clients.

See Also:

Constant Field Values

DEFAULT_OUTGOING_WORKER_THREADS

public static final int DEFAULT_OUTGOING_WORKER_THREADS

The default number of threads to service outgoing requests to servers.

See Also:

Constant Field Values

registeredServers

public final List<HttpProxyServer> registeredServers

List of all servers registered to use this ServerGroup. Any access to this list should be synchronized using the SERVER_REGISTRATION_LOCK.

Constructor Detail

ServerGroup

public ServerGroup(String name,
                   int incomingAcceptorThreads,
                   int incomingWorkerThreads,
                   int outgoingWorkerThreads)

Creates a new ServerGroup instance for a proxy. Threads created for this ServerGroup will have the specified ServerGroup name in the Thread name. This constructor does not actually initialize any thread pools; instead, thread pools for specific transport protocols are lazily initialized as needed.

Parameters:

name - ServerGroup name to include in thread names

incomingAcceptorThreads - number of acceptor threads per protocol

incomingWorkerThreads - number of client-to-proxy worker threads per protocol

outgoingWorkerThreads - number of proxy-to-server worker threads per protocol

Method Detail

registerProxyServer

public void registerProxyServer(HttpProxyServer proxyServer)

Registers the specified proxy server as a consumer of this server group. The server group will not be shut down until the proxy unregisters itself.

Parameters:

proxyServer - proxy server instance to register

unregisterProxyServer

public void unregisterProxyServer(HttpProxyServer proxyServer,
                                  boolean graceful)

Unregisters the specified proxy server from this server group. If this was the last registered proxy server, the server group will be shut down.

Parameters:

proxyServer - proxy server instance to unregister

graceful - when true, the server group shutdown (if necessary) will be graceful

getClientToProxyAcceptorPoolForTransport

public io.netty.channel.EventLoopGroup getClientToProxyAcceptorPoolForTransport(TransportProtocol protocol)

Retrieves the client-to-proxy acceptor thread pool for the specified protocol. Initializes the pool if it has not yet been initialized.

This method is thread-safe; no external locking is necessary.

Parameters:

protocol - transport protocol to retrieve the thread pool for

Returns:

the client-to-proxy acceptor thread pool

getClientToProxyWorkerPoolForTransport

public io.netty.channel.EventLoopGroup getClientToProxyWorkerPoolForTransport(TransportProtocol protocol)

Retrieves the client-to-proxy acceptor worker pool for the specified protocol. Initializes the pool if it has not yet been initialized.

This method is thread-safe; no external locking is necessary.

Parameters:

protocol - transport protocol to retrieve the thread pool for

Returns:

the client-to-proxy worker thread pool

getProxyToServerWorkerPoolForTransport

public io.netty.channel.EventLoopGroup getProxyToServerWorkerPoolForTransport(TransportProtocol protocol)

Retrieves the proxy-to-server worker thread pool for the specified protocol. Initializes the pool if it has not yet been initialized.

This method is thread-safe; no external locking is necessary.

Parameters:

protocol - transport protocol to retrieve the thread pool for

Returns:

the proxy-to-server worker thread pool

isStopped

public boolean isStopped()

Returns:

true if this ServerGroup has already been stopped