All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Typedefs | Enumerations | Functions
src/include/citrusleaf/as_scan.h File Reference
#include <citrusleaf/cl_types.h>
#include <citrusleaf/cl_cluster.h>
#include <citrusleaf/cl_scan.h>
#include <aerospike/as_list.h>
#include <stdbool.h>
+ Include dependency graph for src/include/citrusleaf/as_scan.h:

Go to the source code of this file.

Data Structures

struct  cl_scan
 
struct  cl_scan_params
 
struct  cl_scan_response_rec
 
struct  cl_scan_udf
 

Typedefs

typedef bool(* cl_scan_cb )(const as_val *val, void *udata)
 
typedef uint8_t cl_scan_pct
 

Enumerations

enum  udf_execution_type { CL_SCAN_UDF_NONE, CL_SCAN_UDF_CLIENT_RECORD, CL_SCAN_UDF_BACKGROUND }
 

Functions

cf_vector * citrusleaf_udf_scan_all_nodes (cl_cluster *asc, cl_scan *scan, int(*callback)(as_val *, void *), void *udata)
 
cf_vector * citrusleaf_udf_scan_background (cl_cluster *asc, cl_scan *scan)
 
cl_rv citrusleaf_udf_scan_node (cl_cluster *asc, cl_scan *scan, char *node_name, int(*callback)(as_val *, void *), void *udata)
 
cl_rv citrusleaf_udf_scan_node_background (cl_cluster *asc, cl_scan *scan, char *node_name)
 
int cl_cluster_scan_init (cl_cluster *asc)
 
void cl_cluster_scan_shutdown (cl_cluster *asc)
 
void cl_scan_destroy (cl_scan *scan)
 
int cl_scan_foreach (cl_scan *scan, const char *filename, const char *function, as_list *arglist)
 
cl_scancl_scan_init (cl_scan *scan, const char *ns, const char *setname, uint64_t *job_id)
 
cl_scancl_scan_new (const char *ns, const char *setname, uint64_t *job_id)
 
cl_rv cl_scan_params_init (cl_scan_params *oparams, cl_scan_params *iparams)
 
cl_rv cl_scan_udf_init (cl_scan_udf *udf, udf_execution_type type, const char *filename, const char *function, as_list *arglist)
 

Typedef Documentation

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

Definition at line 78 of file src/include/citrusleaf/as_scan.h.

typedef uint8_t cl_scan_pct

Definition at line 35 of file src/include/citrusleaf/as_scan.h.

Enumeration Type Documentation

Enumerator
CL_SCAN_UDF_NONE 
CL_SCAN_UDF_CLIENT_RECORD 
CL_SCAN_UDF_BACKGROUND 

Definition at line 37 of file src/include/citrusleaf/as_scan.h.

Function Documentation

cf_vector* citrusleaf_udf_scan_all_nodes ( cl_cluster *  asc,
cl_scan scan,
int(*)(as_val *, void *)  callback,
void *  udata 
)
cf_vector* citrusleaf_udf_scan_background ( cl_cluster *  asc,
cl_scan scan 
)
cl_rv citrusleaf_udf_scan_node ( cl_cluster *  asc,
cl_scan scan,
char *  node_name,
int(*)(as_val *, void *)  callback,
void *  udata 
)

Return vector of cl_rv for each node

cl_rv citrusleaf_udf_scan_node_background ( cl_cluster *  asc,
cl_scan scan,
char *  node_name 
)
int cl_cluster_scan_init ( cl_cluster *  asc)
void cl_cluster_scan_shutdown ( cl_cluster *  asc)
void cl_scan_destroy ( cl_scan scan)

Destroy and free an cl_scan

int cl_scan_foreach ( cl_scan scan,
const char *  filename,
const char *  function,
as_list arglist 
)

Initializing udfs

cl_scan* cl_scan_init ( cl_scan scan,
const char *  ns,
const char *  setname,
uint64_t *  job_id 
)

Initializes an cl_scan

cl_scan* cl_scan_new ( const char *  ns,
const char *  setname,
uint64_t *  job_id 
)

Allocates and initializes a new cl_scan

cl_rv cl_scan_params_init ( cl_scan_params oparams,
cl_scan_params iparams 
)
cl_rv cl_scan_udf_init ( cl_scan_udf udf,
udf_execution_type  type,
const char *  filename,
const char *  function,
as_list arglist 
)