com.facebook.swift.service

Class ThriftServerConfig

java.lang.Object

com.facebook.swift.service.ThriftServerConfig

public class ThriftServerConfig
extends Object

Constructor Summary

Constructors

Constructor and Description
ThriftServerConfig()

Method Summary

Modifier and Type	Method and Description
int	getAcceptBacklog()
int	getAcceptorThreadCount()
String	getBindAddress()
int	getConnectionLimit()
io.airlift.units.Duration	getIdleConnectionTimeout()
int	getIoThreadCount()
io.airlift.units.DataSize	getMaxFrameSize()
Integer	getMaxQueuedRequests()
int	getMaxQueuedResponsesPerConnection()
ExecutorService	getOrBuildWorkerExecutor(Map<String,ExecutorService> boundWorkerExecutors) Builds the ExecutorService used for running Thrift server methods.
int	getPort()
String	getProtocolName()
io.airlift.units.Duration	getQueueTimeout()
io.airlift.units.Duration	getTaskExpirationTimeout()
int	getTrafficClass()
String	getTransportName()
String	getWorkerExecutorKey()
int	getWorkerThreads()
ThriftServerConfig	setAcceptBacklog(int acceptBacklog) Sets the number of pending connections that the ServerSocket will queue up before the server process can actually accept them.
ThriftServerConfig	setAcceptorThreadCount(int acceptorThreadCount)
ThriftServerConfig	setBindAddress(String bindAddress)
ThriftServerConfig	setConnectionLimit(int connectionLimit) Sets an upper bound on the number of concurrent connections the server will accept.
ThriftServerConfig	setIdleConnectionTimeout(io.airlift.units.Duration idleConnectionTimeout) Sets a timeout period between receiving requests from a client connection.
ThriftServerConfig	setIoThreadCount(int ioThreadCount)
ThriftServerConfig	setMaxFrameSize(io.airlift.units.DataSize maxFrameSize) Sets a maximum frame size
ThriftServerConfig	setMaxQueuedRequests(Integer maxQueuedRequests) Sets the maximum number of received requests that will wait in the queue to be executed.
ThriftServerConfig	setMaxQueuedResponsesPerConnection(int maxQueuedResponsesPerConnection) Sets the maximum number of responses that may accumulate per connection before the connection starts blocking reads (to avoid building up limitless queued responses).
ThriftServerConfig	setPort(int port)
ThriftServerConfig	setProtocolName(String protocolName) Sets the name of the protocol that this server will speak.
ThriftServerConfig	setQueueTimeout(io.airlift.units.Duration queueTimeout) Sets a timeout period between receiving a request and the pulling the request off the queue.
ThriftServerConfig	setTaskExpirationTimeout(io.airlift.units.Duration taskExpirationTimeout) Sets a timeout period between receiving a request and the completion of that request.
ThriftServerConfig	setTrafficClass(int trafficClass)
ThriftServerConfig	setTransportName(String transportName) Sets the name of the transport (frame codec) that this server will handle.
ThriftServerConfig	setWorkerExecutor(ExecutorService workerExecutor) Sets the executor that will be used to process thrift requests after they arrive.
ThriftServerConfig	setWorkerExecutorKey(String workerExecutorKey) Sets the key for locating an ExecutorService from the mapped executors installed by Guice modules.
ThriftServerConfig	setWorkerThreads(int workerThreads) Sets the number of worker threads that will be created for processing thrift requests after they have arrived.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThriftServerConfig

public ThriftServerConfig()

Method Detail

getBindAddress

public String getBindAddress()

setBindAddress

@Config(value="thrift.bind-address")
public ThriftServerConfig setBindAddress(String bindAddress)

getPort

@Min(value=0L)
 @Max(value=65535L)
public int getPort()

setPort

@Config(value="thrift.port")
public ThriftServerConfig setPort(int port)

getMaxFrameSize

@MinDataSize(value="0B")
 @MaxDataSize(value="1073741823B")
public io.airlift.units.DataSize getMaxFrameSize()

setMaxFrameSize

@Config(value="thrift.max-frame-size")
public ThriftServerConfig setMaxFrameSize(io.airlift.units.DataSize maxFrameSize)

Sets a maximum frame size

Parameters:

maxFrameSize -

Returns:

setAcceptBacklog

@Config(value="thrift.accept-backlog")
public ThriftServerConfig setAcceptBacklog(int acceptBacklog)

Sets the number of pending connections that the ServerSocket will queue up before the server process can actually accept them. If your server may take a lot of connections in a very short interval, you'll want to set this higher to avoid rejecting some of the connections. Setting this to 0 will apply an implementation-specific default.

The default value is 1024.

Actual behavior of the socket backlog is dependent on OS and JDK implementation, and it may even be ignored on some systems. See JDK docs here for details.

Parameters:

acceptBacklog -

Returns:

getAcceptBacklog

@Min(value=0L)
public int getAcceptBacklog()

getAcceptorThreadCount

public int getAcceptorThreadCount()

setAcceptorThreadCount

@Config(value="thrift.acceptor-threads.count")
public ThriftServerConfig setAcceptorThreadCount(int acceptorThreadCount)

getIoThreadCount

public int getIoThreadCount()

setIoThreadCount

@Config(value="thrift.io-threads.count")
public ThriftServerConfig setIoThreadCount(int ioThreadCount)

getTrafficClass

public int getTrafficClass()

setTrafficClass

@Config(value="thrift.traffic-class")
public ThriftServerConfig setTrafficClass(int trafficClass)

getIdleConnectionTimeout

public io.airlift.units.Duration getIdleConnectionTimeout()

setIdleConnectionTimeout

@Config(value="thrift.idle-connection-timeout")
public ThriftServerConfig setIdleConnectionTimeout(io.airlift.units.Duration idleConnectionTimeout)

Sets a timeout period between receiving requests from a client connection. If the timeout is exceeded (no complete requests have arrived from the client within the timeout), the server will disconnect the idle client. The default is 60s.

Parameters:

idleConnectionTimeout - The timeout

Returns:

This ThriftServerConfig instance

getQueueTimeout

public io.airlift.units.Duration getQueueTimeout()

setQueueTimeout

@Config(value="thrift.queue-timeout")
public ThriftServerConfig setQueueTimeout(io.airlift.units.Duration queueTimeout)

Sets a timeout period between receiving a request and the pulling the request off the queue. If the timeout expires before the request reaches the front of the queue and begins processing, the server will discard the request instead of processing it.

Parameters:

queueTimeout - The timeout

Returns:

This ThriftServerConfig instance

getTaskExpirationTimeout

public io.airlift.units.Duration getTaskExpirationTimeout()

setTaskExpirationTimeout

@Config(value="thrift.task-expiration-timeout")
public ThriftServerConfig setTaskExpirationTimeout(io.airlift.units.Duration taskExpirationTimeout)

Sets a timeout period between receiving a request and the completion of that request. If the timeout expires before the request reaches the front of the queue and begins processing, the server will discard the request instead of processing it. If the timeout expires after the request has started processing, the server will send an error immediately, and discard the result of request handling.

Parameters:

taskExpirationTimeout - The timeout

Returns:

This ThriftServerConfig instance

getConnectionLimit

@Min(value=0L)
public int getConnectionLimit()

setConnectionLimit

@Config(value="thrift.connection-limit")
public ThriftServerConfig setConnectionLimit(int connectionLimit)

Sets an upper bound on the number of concurrent connections the server will accept. The default is not to limit the number of connections.

Parameters:

connectionLimit - The maximum number of concurrent connections

Returns:

This ThriftServerConfig instance

getWorkerThreads

@Min(value=1L)
public int getWorkerThreads()

setWorkerThreads

@Config(value="thrift.threads.max")
public ThriftServerConfig setWorkerThreads(int workerThreads)

Sets the number of worker threads that will be created for processing thrift requests after they have arrived. Any value passed here will be ignored if setWorkerExecutor(java.util.concurrent.ExecutorService) is called. The default value is 200.

Parameters:

workerThreads - Number of worker threads to use

Returns:

This ThriftServerConfig instance

getWorkerExecutorKey

public String getWorkerExecutorKey()

setWorkerExecutorKey

@Config(value="thrift.worker-executor-key")
public ThriftServerConfig setWorkerExecutorKey(String workerExecutorKey)

Sets the key for locating an ExecutorService from the mapped executors installed by Guice modules. If you are not configuring your application using Guice, it will probably be simpler to just call setWorkerExecutor(java.util.concurrent.ExecutorService) instead. Use of this method on a ThriftServerConfig instance is incompatible with use of setWorkerExecutor(java.util.concurrent.ExecutorService) or setWorkerThreads(int)

getMaxQueuedRequests

public Integer getMaxQueuedRequests()

setMaxQueuedRequests

@Config(value="thrift.max-queued-requests")
public ThriftServerConfig setMaxQueuedRequests(Integer maxQueuedRequests)

Sets the maximum number of received requests that will wait in the queue to be executed. After this many requests are waiting, the worker queue will start rejecting requests, which will cause the server to fail those requests.

getMaxQueuedResponsesPerConnection

public int getMaxQueuedResponsesPerConnection()

setMaxQueuedResponsesPerConnection

@Config(value="thrift.max-queued-responses-per-connection")
public ThriftServerConfig setMaxQueuedResponsesPerConnection(int maxQueuedResponsesPerConnection)

Sets the maximum number of responses that may accumulate per connection before the connection starts blocking reads (to avoid building up limitless queued responses). This limit applies whenever either the client doesn't support receiving out-of-order responses.

getOrBuildWorkerExecutor

public ExecutorService getOrBuildWorkerExecutor(Map<String,ExecutorService> boundWorkerExecutors)

Builds the ExecutorService used for running Thrift server methods.

The details of the ExecutorService that gets built can be tweaked by calling any of the following (though only one of these should actually be called):

• setWorkerThreads(int)
• setWorkerExecutor(java.util.concurrent.ExecutorService)
• setWorkerExecutorKey(java.lang.String)

The default behavior if none of the above were called is to synthesize a fixed-size ThreadPoolExecutor using DEFAULT_WORKER_THREAD_COUNT threads.

setWorkerExecutor

public ThriftServerConfig setWorkerExecutor(ExecutorService workerExecutor)

Sets the executor that will be used to process thrift requests after they arrive. Setting this will override any call to setWorkerThreads(int). Use of this method on a ThriftServerConfig instance is incompatible with use of setWorkerExecutorKey(String) or setWorkerThreads(int)

Parameters:

workerExecutor - The worker executor

Returns:

This ThriftServerConfig instance

setTransportName

@Config(value="thrift.transport")
public ThriftServerConfig setTransportName(String transportName)

Sets the name of the transport (frame codec) that this server will handle. The available options by default are 'unframed', 'buffered', and 'framed'. Additional modules may install other options. Server startup will fail if you specify an unavailable transport here.

Parameters:

transportName - The name of the transport

Returns:

This ThriftServerConfig instance

getTransportName

@NotNull
public String getTransportName()

setProtocolName

@Config(value="thrift.protocol")
public ThriftServerConfig setProtocolName(String protocolName)

Sets the name of the protocol that this server will speak. The available options by default are 'binary' and 'compact'. Additional modules may install other options. Server startup will fail if you specify an unavailable protocol here.

Parameters:

protocolName - The name of the protocol

Returns:

This ThriftServerConfig instance

getProtocolName

@NotNull
public String getProtocolName()