aerospike_scan.h File Reference

#include <aerospike/aerospike.h>
#include <aerospike/as_listener.h>
#include <aerospike/as_error.h>
#include <aerospike/as_partition_filter.h>
#include <aerospike/as_policy.h>
#include <aerospike/as_record.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)
typedef bool(*	as_async_scan_listener )(as_error *err, as_record *record, void *udata, as_event_loop *event_loop)

Functions
AS_EXTERN as_status	aerospike_scan_async (aerospike *as, as_error *err, const as_policy_scan *policy, as_scan *scan, uint64_t *scan_id, as_async_scan_listener listener, void *udata, as_event_loop *event_loop)
AS_EXTERN as_status	aerospike_scan_background (aerospike *as, as_error *err, const as_policy_scan *policy, const as_scan *scan, uint64_t *scan_id)
AS_EXTERN as_status	aerospike_scan_foreach (aerospike *as, as_error *err, const as_policy_scan *policy, as_scan *scan, aerospike_scan_foreach_callback callback, void *udata)
AS_EXTERN as_status	aerospike_scan_info (aerospike *as, as_error *err, const as_policy_info *policy, uint64_t scan_id, as_scan_info *info)
AS_EXTERN as_status	aerospike_scan_node (aerospike *as, as_error *err, const as_policy_scan *policy, as_scan *scan, const char *node_name, aerospike_scan_foreach_callback callback, void *udata)
AS_EXTERN as_status	aerospike_scan_node_async (aerospike *as, as_error *err, const as_policy_scan *policy, as_scan *scan, uint64_t *scan_id, const char *node_name, as_async_scan_listener listener, void *udata, as_event_loop *event_loop)
AS_EXTERN as_status	aerospike_scan_partitions (aerospike *as, as_error *err, const as_policy_scan *policy, as_scan *scan, as_partition_filter *pf, aerospike_scan_foreach_callback callback, void *udata)
AS_EXTERN as_status	aerospike_scan_partitions_async (aerospike *as, as_error *err, const as_policy_scan *policy, as_scan *scan, as_partition_filter *pf, as_async_scan_listener listener, void *udata, as_event_loop *event_loop)
AS_EXTERN 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_EXTERN 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

as	The aerospike instance to use for this operation.
err	The as_error to be populated if an error occurs.
policy	Scan policy configuration parameters, pass in NULL for default.
scan_id	The id for the scan job.
interval_ms	The polling interval in milliseconds. If zero, 1000 ms is used.

Returns

AEROSPIKE_OK on success. Otherwise an error occurred.