com.aerospike.client.async

Interface IAsyncClient

All Superinterfaces:

AutoCloseable, Closeable, IAerospikeClient

All Known Implementing Classes:

AsyncClient

public interface IAsyncClient
extends IAerospikeClient

THIS CLASS IS OBSOLETE.

The new efficient asynchronous API is located directly in IAerospikeClient. This class exists solely to provide compatibility with legacy applications.

This interface's sole purpose is to allow mock frameworks to operate on AsyncClient without being constrained by final methods.

Method Summary

Modifier and Type	Method and Description
void	add(WritePolicy policy, WriteListener listener, Key key, Bin... bins) Asynchronously add integer bin values to existing record bin values.
void	append(WritePolicy policy, WriteListener listener, Key key, Bin... bins) Asynchronously append bin string values to existing record bin values.
void	delete(WritePolicy policy, DeleteListener listener, Key key) Asynchronously delete record for specified key.
void	execute(WritePolicy policy, ExecuteListener listener, Key key, String packageName, String functionName, Value... functionArgs) Asynchronously execute user defined function on server and return results.
void	exists(BatchPolicy policy, ExistsArrayListener listener, Key[] keys) Asynchronously check if multiple record keys exist in one batch call.
void	exists(BatchPolicy policy, ExistsSequenceListener listener, Key[] keys) Asynchronously check if multiple record keys exist in one batch call.
void	exists(Policy policy, ExistsListener listener, Key key) Asynchronously determine if a record key exists.
void	get(BatchPolicy policy, BatchListListener listener, List<BatchRead> records) Asynchronously read multiple records for specified batch keys in one batch call.
void	get(BatchPolicy policy, BatchSequenceListener listener, List<BatchRead> records) Asynchronously read multiple records for specified batch keys in one batch call.
void	get(BatchPolicy policy, RecordArrayListener listener, Key[] keys) Asynchronously read multiple records for specified keys in one batch call.
void	get(BatchPolicy policy, RecordArrayListener listener, Key[] keys, String... binNames) Asynchronously read multiple record headers and bins for specified keys in one batch call.
void	get(BatchPolicy policy, RecordSequenceListener listener, Key[] keys) Asynchronously read multiple records for specified keys in one batch call.
void	get(BatchPolicy policy, RecordSequenceListener listener, Key[] keys, String... binNames) Asynchronously read multiple record headers and bins for specified keys in one batch call.
void	get(Policy policy, RecordListener listener, Key key) Asynchronously read entire record for specified key.
void	get(Policy policy, RecordListener listener, Key key, String... binNames) Asynchronously read record header and bins for specified key.
BatchPolicy	getAsyncBatchPolicyDefault()
QueryPolicy	getAsyncQueryPolicyDefault()
Policy	getAsyncReadPolicyDefault()
ScanPolicy	getAsyncScanPolicyDefault()
WritePolicy	getAsyncWritePolicyDefault()
void	getHeader(BatchPolicy policy, RecordArrayListener listener, Key[] keys) Asynchronously read multiple record header data for specified keys in one batch call.
void	getHeader(BatchPolicy policy, RecordSequenceListener listener, Key[] keys) Asynchronously read multiple record header data for specified keys in one batch call.
void	getHeader(Policy policy, RecordListener listener, Key key) Asynchronously read record generation and expiration only for specified key.
void	operate(WritePolicy policy, RecordListener listener, Key key, Operation... operations) Asynchronously perform multiple read/write operations on a single key in one batch call.
void	prepend(WritePolicy policy, WriteListener listener, Key key, Bin... bins) Asynchronously prepend bin string values to existing record bin values.
void	put(WritePolicy policy, WriteListener listener, Key key, Bin... bins) Asynchronously write record bin(s).
void	query(QueryPolicy policy, RecordSequenceListener listener, Statement statement) Asynchronously execute query on all server nodes.
void	scanAll(ScanPolicy policy, RecordSequenceListener listener, String namespace, String setName, String... binNames) Asynchronously read all records in specified namespace and set.
void	touch(WritePolicy policy, WriteListener listener, Key key) Asynchronously create record if it does not already exist.

Methods inherited from interface com.aerospike.client.IAerospikeClient

add, add, append, append, changePassword, close, createIndex, createIndex, createRole, createUser, delete, delete, dropIndex, dropRole, dropUser, execute, execute, execute, exists, exists, exists, exists, exists, get, get, get, get, get, get, get, get, get, get, get, get, get, getBatchPolicyDefault, getClusterStats, getHeader, getHeader, getHeader, getHeader, getHeader, getInfoPolicyDefault, getNode, getNodeNames, getNodes, getQueryPolicyDefault, getReadPolicyDefault, getScanPolicyDefault, getWritePolicyDefault, grantPrivileges, grantRoles, isConnected, operate, operate, prepend, prepend, put, put, query, query, queryAggregate, queryAggregate, queryAggregateNode, queryNode, queryRole, queryRoles, queryUser, queryUsers, register, register, registerUdfString, removeUdf, revokePrivileges, revokeRoles, scanAll, scanAll, scanNode, scanNode, touch, touch, truncate

Method Detail

getAsyncReadPolicyDefault

Policy getAsyncReadPolicyDefault()

getAsyncWritePolicyDefault

WritePolicy getAsyncWritePolicyDefault()

getAsyncScanPolicyDefault

ScanPolicy getAsyncScanPolicyDefault()

getAsyncQueryPolicyDefault

QueryPolicy getAsyncQueryPolicyDefault()

getAsyncBatchPolicyDefault

BatchPolicy getAsyncBatchPolicyDefault()

put

void put(WritePolicy policy,
         WriteListener listener,
         Key key,
         Bin... bins)
  throws AerospikeException

Asynchronously write record bin(s). This method schedules the put command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists.

Parameters:

policy - write configuration parameters, pass in null for defaults

listener - where to send results, pass in null for fire and forget

key - unique record identifier

bins - array of bin name/value pairs

Throws:

AerospikeException - if queue is full

append

void append(WritePolicy policy,
            WriteListener listener,
            Key key,
            Bin... bins)
     throws AerospikeException

Asynchronously append bin string values to existing record bin values. This method schedules the append command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call only works for string values.

Parameters:

policy - write configuration parameters, pass in null for defaults

listener - where to send results, pass in null for fire and forget

key - unique record identifier

bins - array of bin name/value pairs

Throws:

AerospikeException - if queue is full

prepend

void prepend(WritePolicy policy,
             WriteListener listener,
             Key key,
             Bin... bins)
      throws AerospikeException

Asynchronously prepend bin string values to existing record bin values. This method schedules the prepend command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call works only for string values.

Parameters:

policy - write configuration parameters, pass in null for defaults

listener - where to send results, pass in null for fire and forget

key - unique record identifier

bins - array of bin name/value pairs

Throws:

AerospikeException - if queue is full

add

void add(WritePolicy policy,
         WriteListener listener,
         Key key,
         Bin... bins)
  throws AerospikeException

Asynchronously add integer bin values to existing record bin values. This method schedules the add command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call only works for integer values.

Parameters:

policy - write configuration parameters, pass in null for defaults

listener - where to send results, pass in null for fire and forget

key - unique record identifier

bins - array of bin name/value pairs

Throws:

AerospikeException - if queue is full

delete

void delete(WritePolicy policy,
            DeleteListener listener,
            Key key)
     throws AerospikeException

Asynchronously delete record for specified key. This method schedules the delete command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy specifies the transaction timeout.

Parameters:

policy - delete configuration parameters, pass in null for defaults

listener - where to send results, pass in null for fire and forget

key - unique record identifier

Throws:

AerospikeException - if queue is full

touch

void touch(WritePolicy policy,
           WriteListener listener,
           Key key)
    throws AerospikeException

Asynchronously create record if it does not already exist. If the record exists, the record's time to expiration will be reset to the policy's expiration.

This method schedules the touch command with a channel selector and returns. Another thread will process the command and send the results to the listener.

Parameters:

policy - write configuration parameters, pass in null for defaults

listener - where to send results, pass in null for fire and forget

key - unique record identifier

Throws:

AerospikeException - if queue is full

exists

void exists(Policy policy,
            ExistsListener listener,
            Key key)
     throws AerospikeException

Asynchronously determine if a record key exists. This method schedules the exists command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy can be used to specify timeouts.

Parameters:

policy - generic configuration parameters, pass in null for defaults

listener - where to send results

key - unique record identifier

Throws:

AerospikeException - if queue is full

exists

void exists(BatchPolicy policy,
            ExistsArrayListener listener,
            Key[] keys)
     throws AerospikeException

Asynchronously check if multiple record keys exist in one batch call. This method schedules the exists command with a channel selector and returns. Another thread will process the command and send the results to the listener in a single call.

The policy can be used to specify timeouts and maximum parallel commands.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

keys - array of unique record identifiers

Throws:

AerospikeException - if queue is full

exists

void exists(BatchPolicy policy,
            ExistsSequenceListener listener,
            Key[] keys)
     throws AerospikeException

Asynchronously check if multiple record keys exist in one batch call. This method schedules the exists command with a channel selector and returns. Another thread will process the command and send the results to the listener in multiple unordered calls.

The policy can be used to specify timeouts and maximum parallel commands.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

keys - array of unique record identifiers

Throws:

AerospikeException - if queue is full

get

void get(Policy policy,
         RecordListener listener,
         Key key)
  throws AerospikeException

Asynchronously read entire record for specified key. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy can be used to specify timeouts.

Parameters:

policy - generic configuration parameters, pass in null for defaults

listener - where to send results

key - unique record identifier

Throws:

AerospikeException - if queue is full

get

void get(Policy policy,
         RecordListener listener,
         Key key,
         String... binNames)
  throws AerospikeException

Asynchronously read record header and bins for specified key. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy can be used to specify timeouts.

Parameters:

policy - generic configuration parameters, pass in null for defaults

listener - where to send results

key - unique record identifier

binNames - bins to retrieve

Throws:

AerospikeException - if queue is full

getHeader

void getHeader(Policy policy,
               RecordListener listener,
               Key key)
        throws AerospikeException

Asynchronously read record generation and expiration only for specified key. Bins are not read. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy can be used to specify timeouts.

Parameters:

policy - generic configuration parameters, pass in null for defaults

listener - where to send results

key - unique record identifier

Throws:

AerospikeException - if queue is full

get

void get(BatchPolicy policy,
         BatchListListener listener,
         List<BatchRead> records)
  throws AerospikeException

Asynchronously read multiple records for specified batch keys in one batch call. This method allows different namespaces/bins to be requested for each key in the batch. The returned records are located in the same list. If the BatchRead key field is not found, the corresponding record field will be null.

This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in a single call. This method requires Aerospike Server version >= 3.6.0.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

records - list of unique record identifiers and the bins to retrieve.

Throws:

AerospikeException - if read fails

get

void get(BatchPolicy policy,
         BatchSequenceListener listener,
         List<BatchRead> records)
  throws AerospikeException

Asynchronously read multiple records for specified batch keys in one batch call. This method allows different namespaces/bins to be requested for each key in the batch. The returned records are located in the same list. If the BatchRead key field is not found, the corresponding record field will be null.

This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in a single call. This method requires Aerospike Server version >= 3.6.0.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

records - list of unique record identifiers and the bins to retrieve.

Throws:

AerospikeException - if read fails

get

void get(BatchPolicy policy,
         RecordArrayListener listener,
         Key[] keys)
  throws AerospikeException

Asynchronously read multiple records for specified keys in one batch call. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in a single call.

If a key is not found, the record will be null. The policy can be used to specify timeouts and maximum parallel commands.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

keys - array of unique record identifiers

Throws:

AerospikeException - if queue is full

get

void get(BatchPolicy policy,
         RecordSequenceListener listener,
         Key[] keys)
  throws AerospikeException

Asynchronously read multiple records for specified keys in one batch call. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in multiple unordered calls.

If a key is not found, the record will be null. The policy can be used to specify timeouts and maximum parallel commands.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

keys - array of unique record identifiers

Throws:

AerospikeException - if queue is full

get

void get(BatchPolicy policy,
         RecordArrayListener listener,
         Key[] keys,
         String... binNames)
  throws AerospikeException

Asynchronously read multiple record headers and bins for specified keys in one batch call. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in a single call.

If a key is not found, the record will be null. The policy can be used to specify timeouts and maximum parallel commands.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

keys - array of unique record identifiers

binNames - array of bins to retrieve

Throws:

AerospikeException - if queue is full

get

void get(BatchPolicy policy,
         RecordSequenceListener listener,
         Key[] keys,
         String... binNames)
  throws AerospikeException

Asynchronously read multiple record headers and bins for specified keys in one batch call. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in multiple unordered calls.

If a key is not found, the record will be null. The policy can be used to specify timeouts and maximum parallel commands.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

keys - array of unique record identifiers

binNames - array of bins to retrieve

Throws:

AerospikeException - if queue is full

getHeader

void getHeader(BatchPolicy policy,
               RecordArrayListener listener,
               Key[] keys)
        throws AerospikeException

Asynchronously read multiple record header data for specified keys in one batch call. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in a single call.

If a key is not found, the record will be null. The policy can be used to specify timeouts and maximum parallel commands.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

keys - array of unique record identifiers

Throws:

AerospikeException - if queue is full

getHeader

void getHeader(BatchPolicy policy,
               RecordSequenceListener listener,
               Key[] keys)
        throws AerospikeException

Asynchronously read multiple record header data for specified keys in one batch call. This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in multiple unordered calls.

If a key is not found, the record will be null. The policy can be used to specify timeouts and maximum parallel commands.

Parameters:

policy - batch configuration parameters, pass in null for defaults

listener - where to send results

keys - array of unique record identifiers

Throws:

AerospikeException - if queue is full

operate

void operate(WritePolicy policy,
             RecordListener listener,
             Key key,
             Operation... operations)
      throws AerospikeException

Asynchronously perform multiple read/write operations on a single key in one batch call. An example would be to add an integer value to an existing record and then read the result, all in one database call.

This method schedules the operate command with a channel selector and returns. Another thread will process the command and send the results to the listener.

Parameters:

policy - write configuration parameters, pass in null for defaults

listener - where to send results, pass in null for fire and forget

key - unique record identifier

operations - database operations to perform

Throws:

AerospikeException - if queue is full

scanAll

void scanAll(ScanPolicy policy,
             RecordSequenceListener listener,
             String namespace,
             String setName,
             String... binNames)
      throws AerospikeException

Asynchronously read all records in specified namespace and set. If the policy's concurrentNodes is specified, each server node will be read in parallel. Otherwise, server nodes are read in series.

This method schedules the scan command with a channel selector and returns. Another thread will process the command and send the results to the listener.

Parameters:

policy - scan configuration parameters, pass in null for defaults

listener - where to send results, pass in null for fire and forget

namespace - namespace - equivalent to database name

setName - optional set name - equivalent to database table

binNames - optional bin to retrieve. All bins will be returned if not specified. Aerospike 2 servers ignore this parameter.

Throws:

AerospikeException - if queue is full

execute

void execute(WritePolicy policy,
             ExecuteListener listener,
             Key key,
             String packageName,
             String functionName,
             Value... functionArgs)
      throws AerospikeException

Asynchronously execute user defined function on server and return results. The function operates on a single record. The package name is used to locate the udf file location on the server:

udf file = /.lua

This method schedules the execute command with a channel selector and returns. Another thread will process the command and send the results to the listener.

Parameters:

policy - write configuration parameters, pass in null for defaults

listener - where to send results

key - unique record identifier

packageName - server package name where user defined function resides

functionName - user defined function

functionArgs - arguments passed in to user defined function

Throws:

AerospikeException - if transaction fails

query

void query(QueryPolicy policy,
           RecordSequenceListener listener,
           Statement statement)
    throws AerospikeException

Asynchronously execute query on all server nodes. The query policy's maxConcurrentNodes dictate how many nodes can be queried in parallel. The default is to query all nodes in parallel.

This method schedules the node's query commands with channel selectors and returns. Selector threads will process the commands and send the results to the listener.

Parameters:

policy - query configuration parameters, pass in null for defaults

listener - where to send results

statement - database query command parameters

Throws:

AerospikeException - if query fails