com.aerospike.client.async.AsyncClientPolicy Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2012-2014 by Aerospike.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
******************************************************************************/
package com.aerospike.client.async;
import java.util.concurrent.ExecutorService;
import com.aerospike.client.policy.ClientPolicy;
/**
* Container object for client policy Command.
*/
public final class AsyncClientPolicy extends ClientPolicy {
/**
* How to handle cases when the asynchronous maximum number of concurrent connections
* have been reached.
*/
public MaxCommandAction asyncMaxCommandAction = MaxCommandAction.BLOCK;
/**
* 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
*/
public int asyncMaxCommands = 200;
/**
* Maximum milliseconds to wait for an asynchronous network selector event.
* The default value of zero indicates the selector should not timeout.
*/
public int asyncSelectorTimeout;
/**
* 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.
*/
public int asyncSelectorThreads = 1;
/**
* Asynchronous socket read/user callback task thread pool. The default, null, indicates
* asynchronous tasks should be run in the same thread as the selector.
*
* Example: asyncTaskThreadPool = Executors.newCachedThreadPool();
*/
public ExecutorService asyncTaskThreadPool;
}