com.aerospike.client.async

Class AsyncClientPolicy

java.lang.Object

com.aerospike.client.policy.ClientPolicy

com.aerospike.client.async.AsyncClientPolicy

public final class AsyncClientPolicy
extends ClientPolicy

THIS CLASS IS OBSOLETE.

This class is not used by the new efficient asynchronous client. This class exists solely to provide compatibility with legacy applications.

Container object for client policy Command.

Field Summary

Fields

Modifier and Type	Field and Description
BatchPolicy	asyncBatchPolicyDefault Default batch policy that is used when asynchronous batch command's policy is null.
MaxCommandAction	asyncMaxCommandAction How to handle cases when the asynchronous maximum number of concurrent connections have been reached.
int	asyncMaxCommands Maximum number of concurrent asynchronous commands that are active at any point in time.
QueryPolicy	asyncQueryPolicyDefault Default scan policy that is used when asynchronous query command's policy is null.
Policy	asyncReadPolicyDefault Default read policy that is used when asynchronous read command's policy is null.
ScanPolicy	asyncScanPolicyDefault Default scan policy that is used when asynchronous scan command's policy is null.
int	asyncSelectorThreads Number of selector threads used to process asynchronous network events.
int	asyncSelectorTimeout Maximum milliseconds to wait for an asynchronous network selector event.
ExecutorService	asyncTaskThreadPool Asynchronous socket read/user callback task thread pool.
WritePolicy	asyncWritePolicyDefault Default write policy that is used when asynchronous write command's policy is null.

Fields inherited from class com.aerospike.client.policy.ClientPolicy

batchPolicyDefault, clusterName, connPoolsPerNode, eventLoops, failIfNotConnected, infoPolicyDefault, ipMap, maxConnsPerNode, maxSocketIdle, password, queryPolicyDefault, readPolicyDefault, requestProleReplicas, scanPolicyDefault, sharedThreadPool, tendInterval, threadPool, timeout, tlsPolicy, user, useServicesAlternate, writePolicyDefault

Constructor Summary

Constructors

Constructor and Description
AsyncClientPolicy() Default constructor.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

asyncMaxCommandAction

public MaxCommandAction asyncMaxCommandAction

How to handle cases when the asynchronous maximum number of concurrent connections have been reached.

asyncMaxCommands

public int asyncMaxCommands

Maximum number of concurrent asynchronous commands that are active at any point in time. Concurrent commands can be used to estimate concurrent connections. The number of concurrent open connections is limited by:

max open connections = asyncMaxCommands *

The actual number of open connections consumed depends on how balanced the commands are between nodes and if asyncMaxConnAction is ACCEPT.

The maximum open connections should not exceed the total socket file descriptors available on the client machine. The socket file descriptors available can be determined by the following command:

ulimit -n

asyncSelectorTimeout

public int asyncSelectorTimeout

Maximum milliseconds to wait for an asynchronous network selector event. The default value of zero indicates the selector should not timeout.

asyncSelectorThreads

public int asyncSelectorThreads

Number of selector threads used to process asynchronous network events. The default is a single threaded network handler. Some applications may benefit from increasing this value to the number of CPU cores on the executing machine.

asyncTaskThreadPool

public ExecutorService asyncTaskThreadPool

Asynchronous socket read/user callback task thread pool. If asyncTaskThreadPool is not defined (default), asynchronous tasks will be run in the same thread as the selector. If asyncTaskThreadPool is defined, the socket read and user callback will be run in a separate thread from the selector thread.

A variable sized thread pool can handle any amount of tasks.

 // Daemon threads automatically terminate when the program terminates.
 asyncTaskThreadPool = Executors.newCachedThreadPool(new ThreadFactory() {
     public final Thread newThread(Runnable runnable) {
                        Thread thread = new Thread(runnable);
                        thread.setDaemon(true);
                        return thread;
                }
 });
 

If a fixed size thread pool is desired, the size should be the same as asyncMaxCommands.

 asyncTaskThreadPool = Executors.newFixedThreadPool(asyncMaxCommands, new ThreadFactory() {
     public final Thread newThread(Runnable runnable) {
                        Thread thread = new Thread(runnable);
                        thread.setDaemon(true);
                        return thread;
                }
 });
 

Deadlock can occur when asyncTaskThreadPool is not defined, asyncMaxCommandAction equals BLOCK and there are many instances of nested async commands (one command triggers new commands in the user callback). It is imperative that asyncTaskThreadPool be defined if your application is using this scenario.

asyncReadPolicyDefault

public Policy asyncReadPolicyDefault

Default read policy that is used when asynchronous read command's policy is null.

asyncWritePolicyDefault

public WritePolicy asyncWritePolicyDefault

Default write policy that is used when asynchronous write command's policy is null.

asyncScanPolicyDefault

public ScanPolicy asyncScanPolicyDefault

Default scan policy that is used when asynchronous scan command's policy is null.

asyncQueryPolicyDefault

public QueryPolicy asyncQueryPolicyDefault

Default scan policy that is used when asynchronous query command's policy is null.

asyncBatchPolicyDefault

public BatchPolicy asyncBatchPolicyDefault

Default batch policy that is used when asynchronous batch command's policy is null.

Constructor Detail

AsyncClientPolicy

public AsyncClientPolicy()

Default constructor.