Name | Description | |
---|---|---|
![]() | AsyncClientPolicy |
Default constructor.
|
![]() | AsyncClientPolicy(AsyncClientPolicy) |
Copy async client policy from another async client policy.
|
Name | Description | |
---|---|---|
![]() | asyncMaxCommandAction |
How to handle cases when the asynchronous maximum number of concurrent connections
have been reached.
|
![]() | 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 * <number of nodes in cluster> 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 |
![]() | authMode |
Authentication mode used when user/password is defined.
(Inherited from ClientPolicy.)Default: INTERNAL |
![]() | batchPolicyDefault |
Default batch policy that is used when batch command's policy is null.
(Inherited from ClientPolicy.) |
![]() | clusterName |
Expected cluster name. If populated, server nodes must return this cluster name in order to
join the client's view of the cluster. Should only be set when connecting to servers that
support the "cluster-name" info command.
(Inherited from ClientPolicy.) |
![]() | connPoolsPerNode |
Number of synchronous connection pools used for each node. Machines with 8 cpu cores or
less usually need just one connection pool per node. Machines with a large number of cpu
cores may have their synchronous performance limited by contention for pooled connections.
Contention for pooled connections can be reduced by creating multiple mini connection pools
per node.
(Inherited from ClientPolicy.)Default: 1 |
![]() | failIfNotConnected |
Throw exception if all seed connections fail on cluster instantiation. Default: true
(Inherited from ClientPolicy.) |
![]() | infoPolicyDefault |
Default info policy that is used when info command's policy is null.
(Inherited from ClientPolicy.) |
![]() | ipMap |
A IP translation table is used in cases where different clients use different server
IP addresses. This may be necessary when using clients from both inside and outside
a local area network. Default is no translation.
(Inherited from ClientPolicy.)The key is the IP address returned from friend info requests to other servers. The value is the real IP address used to connect to the server. |
![]() | loginTimeout |
Login timeout in milliseconds. The timeout used when user authentication is enabled and
a node login is being performed.
(Inherited from ClientPolicy.)Default: 5000ms |
![]() | maxConnsPerNode |
Maximum number of connections allowed per server node. Synchronous transactions
will go through retry logic and potentially fail with "ResultCode.NO_MORE_CONNECTIONS"
if the maximum number of connections would be exceeded.
(Inherited from ClientPolicy.)The number of connections used per node depends on how many concurrent threads issue database commands plus sub-threads used for parallel multi-node commands (batch, scan, and query). One connection will be used for each thread. This field is ignored by asynchronous transactions since these transactions are already bound by asyncMaxCommands by default. Each async command has a one-to-one relationship with connections. Default: 300 |
![]() | maxSocketIdle |
Maximum socket idle in seconds. Socket connection pools will discard sockets
that have been idle longer than the maximum. The value is limited to 24 hours (86400).
(Inherited from ClientPolicy.)It's important to set this value to a few seconds less than the server's proto-fd-idle-ms (default 60000 milliseconds or 1 minute), so the client does not attempt to use a socket that has already been reaped by the server. Default: 55 seconds |
![]() | password |
Password authentication to cluster. The password will be stored by the client and sent to server
in hashed format. Leave null for clusters running without restricted access.
(Inherited from ClientPolicy.) |
![]() | queryPolicyDefault |
Default query policy that is used when query command's policy is null.
(Inherited from ClientPolicy.) |
![]() | readPolicyDefault |
Default read policy that is used when read command's policy is null.
(Inherited from ClientPolicy.) |
![]() | requestProleReplicas |
Should prole replicas be requested from each server node in the cluster tend thread.
This option is required if there is a need to distribute reads across proles.
(replica ==
MASTER_PROLES or
SEQUENCE).
(Inherited from ClientPolicy.)If requestProleReplicas is enabled, all prole partition maps will be cached on the client which results in extra storage multiplied by the replication factor. Default: true (request all master and prole replicas). |
![]() | scanPolicyDefault |
Default scan policy that is used when scan command's policy is null.
(Inherited from ClientPolicy.) |
![]() | tendInterval |
Interval in milliseconds between cluster tends by maintenance thread. Default: 1 second
(Inherited from ClientPolicy.) |
![]() | timeout |
Initial host connection timeout in milliseconds. The timeout when opening a connection
to the server host for the first time.
(Inherited from ClientPolicy.)Default: 1000ms |
![]() | tlsPolicy |
Secure connection policy for servers that require TLS connections.
Secure connections are only supported for AerospikeClient synchronous commands.
(Inherited from ClientPolicy.)Secure connections are not supported for asynchronous commands because AsyncClient uses the best performing SocketAsyncEventArgs. Unfortunately, SocketAsyncEventArgs is not supported by the provided SslStream. Default: null (Use normal sockets) |
![]() | user |
User authentication to cluster. Leave null for clusters running without restricted access.
(Inherited from ClientPolicy.) |
![]() | useServicesAlternate |
Should use "services-alternate" instead of "services" in info request during cluster
tending. "services-alternate" returns server configured external IP addresses that client
uses to talk to nodes. "services-alternate" can be used in place of providing a client "ipMap".
Default: false (use original "services" info request).
(Inherited from ClientPolicy.)"services-alternate" is available with Aerospike Server versions >= 3.7.1. |
![]() | writePolicyDefault |
Default write policy that is used when write command's policy is null.
(Inherited from ClientPolicy.) |