All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Enumerations | Functions
cl_scan.h File Reference
#include <citrusleaf/cl_types.h>
#include <citrusleaf/cl_cluster.h>
+ Include dependency graph for cl_scan.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  cl_node_response
 
struct  cl_scan_param_field
 
struct  cl_scan_parameters
 

Enumerations

enum  cl_scan_priority { CL_SCAN_PRIORITY_AUTO, CL_SCAN_PRIORITY_LOW, CL_SCAN_PRIORITY_MEDIUM, CL_SCAN_PRIORITY_HIGH }
 

Functions

cf_vector * citrusleaf_get_job_status_all_nodes (cl_cluster *asc, uint64_t job_uid)
 
cl_rv citrusleaf_scan (cl_cluster *asc, char *ns, char *set, cl_bin *bins, int n_bins, bool get_key, citrusleaf_get_many_cb cb, void *udata, bool nobindata)
 
cf_vector * citrusleaf_scan_all_nodes (cl_cluster *asc, char *ns, char *set, cl_bin *bins, int n_bins, bool nobindata, uint8_t scan_pct, citrusleaf_get_many_cb cb, void *udata, cl_scan_parameters *scan_p)
 
cl_rv citrusleaf_scan_node (cl_cluster *asc, char *node_name, char *ns, char *set, cl_bin *bins, int n_bins, bool nobindata, uint8_t scan_pct, citrusleaf_get_many_cb cb, void *udata, cl_scan_parameters *scan_p)
 
cf_vector * citrusleaf_terminate_job_all_nodes (cl_cluster *asc, uint64_t job_uid)
 
static void cl_scan_parameters_set_default (cl_scan_parameters *cl_scan_p)
 

Enumeration Type Documentation

get many call has the following properties: you can pass null either with the namespace or the set, and a large iteration will occur Memory available vanishes after 'return', if you want a copy, make a copy Non-zero return in the callback aborts the call

Enumerator
CL_SCAN_PRIORITY_AUTO 
CL_SCAN_PRIORITY_LOW 
CL_SCAN_PRIORITY_MEDIUM 
CL_SCAN_PRIORITY_HIGH 

Definition at line 42 of file cl_scan.h.

Function Documentation

cf_vector* citrusleaf_get_job_status_all_nodes ( cl_cluster *  asc,
uint64_t  job_uid 
)
cl_rv citrusleaf_scan ( cl_cluster *  asc,
char *  ns,
char *  set,
cl_bin bins,
int  n_bins,
bool  get_key,
citrusleaf_get_many_cb  cb,
void *  udata,
bool  nobindata 
)
cf_vector* citrusleaf_scan_all_nodes ( cl_cluster *  asc,
char *  ns,
char *  set,
cl_bin bins,
int  n_bins,
bool  nobindata,
uint8_t  scan_pct,
citrusleaf_get_many_cb  cb,
void *  udata,
cl_scan_parameters *  scan_p 
)

response is a vector of cl_node_response

cl_rv citrusleaf_scan_node ( cl_cluster *  asc,
char *  node_name,
char *  ns,
char *  set,
cl_bin bins,
int  n_bins,
bool  nobindata,
uint8_t  scan_pct,
citrusleaf_get_many_cb  cb,
void *  udata,
cl_scan_parameters *  scan_p 
)
cf_vector* citrusleaf_terminate_job_all_nodes ( cl_cluster *  asc,
uint64_t  job_uid 
)
static void cl_scan_parameters_set_default ( cl_scan_parameters *  cl_scan_p)
inlinestatic

Definition at line 82 of file cl_scan.h.

References CL_SCAN_PRIORITY_AUTO.