ServerGroup (Zodiac Server Proxy 1.2.5 API)

java.lang.Object
- org.zodiac.server.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(HttpProxyManager), and when they shut down, must unregister with the ServerGroup using unregisterProxyServer(HttpProxyManager, boolean).

字段概要

字段
限定符和类型	字段和说明
`private int`	`eventGroupAwaitTimeoutSeconds`
`private long`	`eventGroupGracefulShutdownQuietPeriodSeconds`
`private long`	`eventGroupGracefulShutdownTimeoutSeconds`
`private int`	`incomingAcceptorThreads`
`private int`	`incomingWorkerIoRatio`
`private int`	`incomingWorkerThreads`
`private static org.slf4j.Logger`	`LOG`
`private String`	`name`
`private int`	`outgoingWorkerIoRatio`
`private int`	`outgoingWorkerThreads`
`private EnumMap<TransportProtocol,ProxyThreadPools>`	`protocolThreadPools`
`List<HttpProxyManager>`	`registeredServers`
`private Object`	`SERVER_REGISTRATION_LOCK` Lock controlling access to the `registerProxyServer(HttpProxyManager)` and `unregisterProxyServer(HttpProxyManager, boolean)` methods.
`private static AtomicInteger`	`serverGroupCount`
`private int`	`serverGroupId`
`private AtomicBoolean`	`stopped`
`private Object`	`threadPoolInitLock`
`private static EnumMap<TransportProtocol,SelectorProvider>`	`TRANSPORT_PROTOCOL_SELECTOR_PROVIDERS`

构造器概要

构造器
构造器和说明
`ServerGroup(String name, int incomingAcceptorThreads, int incomingWorkerThreads, int outgoingWorkerThreads)` 已过时。
`ServerGroup(String name, int incomingAcceptorThreads, int incomingWorkerThreads, int incomingWorkerIoRatio, int outgoingWorkerThreads, int outgoingWorkerIoRatio, long eventGroupGracefulShutdownQuietPeriodSeconds, long eventGroupGracefulShutdownTimeoutSeconds, int eventGroupAwaitTimeoutSeconds)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`EventLoopGroup`	`getClientToProxyAcceptorPoolForTransport(TransportProtocol protocol)` Retrieves the client-to-proxy acceptor thread pool for the specified protocol.
`EventLoopGroup`	`getClientToProxyWorkerPoolForTransport(TransportProtocol protocol)` Retrieves the client-to-proxy acceptor worker pool for the specified protocol.
`EventLoopGroup`	`getProxyToServerWorkerPoolForTransport(TransportProtocol protocol)` Retrieves the proxy-to-server worker thread pool for the specified protocol.
`private ProxyThreadPools`	`getThreadPoolsForProtocol(TransportProtocol protocol)` Retrieves the `ProxyThreadPools` for the specified transport protocol.
`boolean`	`isStopped()`
`void`	`registerProxyServer(HttpProxyManager proxyServer)` Registers the specified proxy server as a consumer of this server group.
`private void`	`shutdown(boolean graceful)` Shuts down all event loops owned by this server group.
`void`	`unregisterProxyServer(HttpProxyManager proxyServer, boolean graceful)` Unregisters the specified proxy server from this server group.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - LOG
```
private static final org.slf4j.Logger LOG
```
  - TRANSPORT_PROTOCOL_SELECTOR_PROVIDERS
```
private static final EnumMap<TransportProtocol,SelectorProvider> TRANSPORT_PROTOCOL_SELECTOR_PROVIDERS
```
  - serverGroupCount
```
private static final AtomicInteger serverGroupCount
```
  - name
```
private final String name
```
  - serverGroupId
```
private final int serverGroupId
```
  - incomingAcceptorThreads
```
private final int incomingAcceptorThreads
```
  - incomingWorkerThreads
```
private final int incomingWorkerThreads
```
  - incomingWorkerIoRatio
```
private final int incomingWorkerIoRatio
```
  - outgoingWorkerThreads
```
private final int outgoingWorkerThreads
```
  - outgoingWorkerIoRatio
```
private final int outgoingWorkerIoRatio
```
  - eventGroupGracefulShutdownQuietPeriodSeconds
```
private final long eventGroupGracefulShutdownQuietPeriodSeconds
```
  - eventGroupGracefulShutdownTimeoutSeconds
```
private final long eventGroupGracefulShutdownTimeoutSeconds
```
  - eventGroupAwaitTimeoutSeconds
```
private final int eventGroupAwaitTimeoutSeconds
```
  - registeredServers
```
public final List<HttpProxyManager> registeredServers
```
  - protocolThreadPools
```
private final EnumMap<TransportProtocol,ProxyThreadPools> protocolThreadPools
```
  - threadPoolInitLock
```
private final Object threadPoolInitLock
```
  - stopped
```
private final AtomicBoolean stopped
```
  - SERVER_REGISTRATION_LOCK
```
private final Object SERVER_REGISTRATION_LOCK
```
    Lock controlling access to the registerProxyServer(HttpProxyManager) and unregisterProxyServer(HttpProxyManager, boolean) methods.
- 构造器详细资料
  - ServerGroup
```
@Deprecated
public ServerGroup(String name,
                                int incomingAcceptorThreads,
                                int incomingWorkerThreads,
                                int outgoingWorkerThreads)
```
    已过时。
  - ServerGroup
```
public ServerGroup(String name,
                   int incomingAcceptorThreads,
                   int incomingWorkerThreads,
                   int incomingWorkerIoRatio,
                   int outgoingWorkerThreads,
                   int outgoingWorkerIoRatio,
                   long eventGroupGracefulShutdownQuietPeriodSeconds,
                   long eventGroupGracefulShutdownTimeoutSeconds,
                   int eventGroupAwaitTimeoutSeconds)
```
- 方法详细资料
  - getThreadPoolsForProtocol
```
private ProxyThreadPools getThreadPoolsForProtocol(TransportProtocol protocol)
```
    Retrieves the ProxyThreadPools for the specified transport protocol. Lazily initializes the thread pools for the transport protocol if they have not yet been initialized. If the protocol has already been initialized, this method returns immediately, without synchronization. If initialization is necessary, the initialization process creates the acceptor and worker threads necessary to service requests to/from the proxy.
    This method is thread-safe; no external locking is necessary.
    
    参数:
    
    protocol - transport protocol to retrieve thread pools for
    
    返回:
    
    thread pools for the specified transport protocol
  - registerProxyServer
```
public void registerProxyServer(HttpProxyManager 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.
    
    参数:
    
    proxyServer - proxy server instance to register
  - unregisterProxyServer
```
public void unregisterProxyServer(HttpProxyManager 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.
    
    参数:
    
    proxyServer - proxy server instance to unregister
    
    graceful - when true, the server group shutdown (if necessary) will be graceful
  - shutdown
```
private void shutdown(boolean graceful)
```
    Shuts down all event loops owned by this server group.
    
    参数:
    
    graceful - when true, event loops will "gracefully" terminate, waiting for submitted tasks to finish
  - getClientToProxyAcceptorPoolForTransport
```
public 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.
    
    参数:
    
    protocol - transport protocol to retrieve the thread pool for
    
    返回:
    
    the client-to-proxy acceptor thread pool
  - getClientToProxyWorkerPoolForTransport
```
public 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.
    
    参数:
    
    protocol - transport protocol to retrieve the thread pool for
    
    返回:
    
    the client-to-proxy worker thread pool
  - getProxyToServerWorkerPoolForTransport
```
public 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.
    
    参数:
    
    protocol - transport protocol to retrieve the thread pool for
    
    返回:
    
    the proxy-to-server worker thread pool
  - isStopped
```
public boolean isStopped()
```
    返回:
    
    true if this ServerGroup has already been stopped

类 ServerGroup

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

LOG

TRANSPORT_PROTOCOL_SELECTOR_PROVIDERS

serverGroupCount

name

serverGroupId

incomingAcceptorThreads

incomingWorkerThreads

incomingWorkerIoRatio

outgoingWorkerThreads

outgoingWorkerIoRatio

eventGroupGracefulShutdownQuietPeriodSeconds

eventGroupGracefulShutdownTimeoutSeconds

eventGroupAwaitTimeoutSeconds

registeredServers

protocolThreadPools

threadPoolInitLock

stopped

SERVER_REGISTRATION_LOCK

构造器详细资料

ServerGroup

ServerGroup

方法详细资料

getThreadPoolsForProtocol

registerProxyServer

unregisterProxyServer

shutdown

getClientToProxyAcceptorPoolForTransport

getClientToProxyWorkerPoolForTransport

getProxyToServerWorkerPoolForTransport

isStopped