All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Typedefs | Functions
aerospike_scan.h File Reference
#include <aerospike/aerospike.h>
#include <aerospike/as_error.h>
#include <aerospike/as_policy.h>
#include <aerospike/as_scan.h>
#include <aerospike/as_status.h>
#include <aerospike/as_val.h>
+ Include dependency graph for aerospike_scan.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef bool(* aerospike_scan_foreach_callback )(const as_val *val, void *udata)
 

Functions

as_status aerospike_scan_background (aerospike *as, as_error *err, const as_policy_scan *policy, const as_scan *scan, uint64_t *scan_id)
 
as_status aerospike_scan_foreach (aerospike *as, as_error *err, const as_policy_scan *policy, const as_scan *scan, aerospike_scan_foreach_callback callback, void *udata)
 
as_status aerospike_scan_info (aerospike *as, as_error *err, const as_policy_info *policy, uint64_t scan_id, as_scan_info *info)
 
as_status aerospike_scan_wait (aerospike *as, as_error *err, const as_policy_info *policy, uint64_t scan_id, uint32_t interval_ms)
 

Function Documentation

as_status aerospike_scan_wait ( aerospike as,
as_error err,
const as_policy_info policy,
uint64_t  scan_id,
uint32_t  interval_ms 
)

Wait for a background scan to be completed by servers.

uint64_t scan_id = 1234;
aerospike_scan_wait(&as, &err, NULL, scan_id, 0);
Parameters
asThe aerospike instance to use for this operation.
errThe as_error to be populated if an error occurs.
policyThe policy to use for this operation. If NULL, then the default policy will be used.
scan_idThe id for the scan job.
interval_msThe polling interval in milliseconds. If zero, 1000 ms is used.
Returns
AEROSPIKE_OK on success. Otherwise an error occurred.