All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Macros | Typedefs | Enumerations | Functions
cl_types.h File Reference
#include <citrusleaf/cl_object.h>
#include <inttypes.h>
#include <stdbool.h>
#include <netinet/in.h>
#include <citrusleaf/cf_atomic.h>
#include <citrusleaf/cf_ll.h>
#include <citrusleaf/cf_clock.h>
#include <citrusleaf/cf_vector.h>
#include <citrusleaf/cf_queue.h>
#include <citrusleaf/cf_digest.h>
#include <citrusleaf/cf_shash.h>
#include <citrusleaf/cf_rchash.h>
+ Include dependency graph for cl_types.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  cl_addrmap
 
struct  cl_batchresult
 
struct  cl_bin
 
struct  cl_operation
 
struct  cl_rec
 

Macros

#define CL_BINNAME_SIZE   15
 
#define CL_MAX_NUM_FUNC_ARGC   10
 
#define DEFAULT_PROGRESS_TIMEOUT   50
 
#define NODE_NAME_SIZE   20
 
#define STACK_BUF_SZ   (1024 * 16)
 

Typedefs

typedef int(* citrusleaf_get_many_cb )(char *ns, cf_digest *keyd, char *set, cl_object *key, int result, uint32_t generation, uint32_t ttl, cl_bin *bins, uint16_t n_bins, void *udata)
 
typedef struct cl_conn_s cl_conn
 

Enumerations

enum  cl_operator {
  CL_OP_WRITE, CL_OP_READ, CL_OP_INCR, CL_OP_MC_INCR,
  CL_OP_PREPEND, CL_OP_APPEND, CL_OP_MC_PREPEND, CL_OP_MC_APPEND,
  CL_OP_TOUCH, CL_OP_MC_TOUCH
}
 
enum  cl_rv {
  CITRUSLEAF_FAIL_ASYNCQ_FULL = -3, CITRUSLEAF_FAIL_TIMEOUT = -2, CITRUSLEAF_FAIL_CLIENT = -1, CITRUSLEAF_OK = 0,
  CITRUSLEAF_FAIL_UNKNOWN = 1, CITRUSLEAF_FAIL_NOTFOUND = 2, CITRUSLEAF_FAIL_GENERATION = 3, CITRUSLEAF_FAIL_PARAMETER = 4,
  CITRUSLEAF_FAIL_KEY_EXISTS = 5, CITRUSLEAF_FAIL_BIN_EXISTS = 6, CITRUSLEAF_FAIL_CLUSTER_KEY_MISMATCH = 7, CITRUSLEAF_FAIL_PARTITION_OUT_OF_SPACE = 8,
  CITRUSLEAF_FAIL_SERVERSIDE_TIMEOUT = 9, CITRUSLEAF_FAIL_NOXDS = 10, CITRUSLEAF_FAIL_UNAVAILABLE = 11, CITRUSLEAF_FAIL_INCOMPATIBLE_TYPE = 12,
  CITRUSLEAF_FAIL_RECORD_TOO_BIG = 13, CITRUSLEAF_FAIL_KEY_BUSY = 14, CITRUSLEAF_FAIL_SCAN_ABORT = 15, CITRUSLEAF_FAIL_UNSUPPORTED_FEATURE = 16,
  CITRUSLEAF_FAIL_BIN_NOT_FOUND = 17, CITRUSLEAF_FAIL_DEVICE_OVERLOAD = 18, CITRUSLEAF_FAIL_KEY_MISMATCH = 19, CITRUSLEAF_FAIL_INVALID_DATA = 99,
  CITRUSLEAF_FAIL_UDF_BAD_RESPONSE = 100, CITRUSLEAF_FAIL_INDEX_FOUND = 200, CITRUSLEAF_FAIL_INDEX_NOTFOUND = 201, CITRUSLEAF_FAIL_INDEX_OOM = 202,
  CITRUSLEAF_FAIL_INDEX_NOTREADABLE = 203, CITRUSLEAF_FAIL_INDEX_GENERIC = 204, CITRUSLEAF_FAIL_INDEX_NAME_MAXLEN = 205, CITRUSLEAF_FAIL_INDEX_MAXCOUNT = 206,
  CITRUSLEAF_FAIL_QUERY_ABORTED = 210, CITRUSLEAF_FAIL_QUERY_QUEUEFULL = 211, CITRUSLEAF_FAIL_QUERY_TIMEOUT = 212, CITRUSLEAF_FAIL_QUERY_GENERIC = 213
}
 
enum  cl_rvclient { CITRUSLEAF_FAIL_DC_DOWN = 1, CITRUSLEAF_FAIL_DC_UP = 2 }
 

Functions

void citrusleaf_bins_free (cl_bin *bins, int n_bins)
 
int citrusleaf_copy_bins (cl_bin **destbins, cl_bin *srcbins, int n_bins)
 

Macro Definition Documentation

#define CL_BINNAME_SIZE   15

Definition at line 53 of file cl_types.h.

#define CL_MAX_NUM_FUNC_ARGC   10

Definition at line 54 of file cl_types.h.

#define DEFAULT_PROGRESS_TIMEOUT   50

Definition at line 51 of file cl_types.h.

#define NODE_NAME_SIZE   20

Definition at line 52 of file cl_types.h.

#define STACK_BUF_SZ   (1024 * 16)

Hack for the sake of XDS. XDS includes the main CF libs. We do not want to include them again from client API

Definition at line 50 of file cl_types.h.

Typedef Documentation

typedef int(* citrusleaf_get_many_cb)(char *ns, cf_digest *keyd, char *set, cl_object *key, int result, uint32_t generation, uint32_t ttl, cl_bin *bins, uint16_t n_bins, void *udata)

Callback function type used by batch and scan

Definition at line 223 of file cl_types.h.

typedef struct cl_conn_s cl_conn

Definition at line 60 of file cl_types.h.

Enumeration Type Documentation

Enumerator
CL_OP_WRITE 
CL_OP_READ 
CL_OP_INCR 
CL_OP_MC_INCR 
CL_OP_PREPEND 
CL_OP_APPEND 
CL_OP_MC_PREPEND 
CL_OP_MC_APPEND 
CL_OP_TOUCH 
CL_OP_MC_TOUCH 

Definition at line 161 of file cl_types.h.

enum cl_rv
Enumerator
CITRUSLEAF_FAIL_ASYNCQ_FULL 
CITRUSLEAF_FAIL_TIMEOUT 
CITRUSLEAF_FAIL_CLIENT 
CITRUSLEAF_OK 
CITRUSLEAF_FAIL_UNKNOWN 
CITRUSLEAF_FAIL_NOTFOUND 
CITRUSLEAF_FAIL_GENERATION 
CITRUSLEAF_FAIL_PARAMETER 
CITRUSLEAF_FAIL_KEY_EXISTS 
CITRUSLEAF_FAIL_BIN_EXISTS 
CITRUSLEAF_FAIL_CLUSTER_KEY_MISMATCH 
CITRUSLEAF_FAIL_PARTITION_OUT_OF_SPACE 
CITRUSLEAF_FAIL_SERVERSIDE_TIMEOUT 
CITRUSLEAF_FAIL_NOXDS 
CITRUSLEAF_FAIL_UNAVAILABLE 
CITRUSLEAF_FAIL_INCOMPATIBLE_TYPE 
CITRUSLEAF_FAIL_RECORD_TOO_BIG 
CITRUSLEAF_FAIL_KEY_BUSY 
CITRUSLEAF_FAIL_SCAN_ABORT 
CITRUSLEAF_FAIL_UNSUPPORTED_FEATURE 
CITRUSLEAF_FAIL_BIN_NOT_FOUND 
CITRUSLEAF_FAIL_DEVICE_OVERLOAD 
CITRUSLEAF_FAIL_KEY_MISMATCH 
CITRUSLEAF_FAIL_INVALID_DATA 
CITRUSLEAF_FAIL_UDF_BAD_RESPONSE 
CITRUSLEAF_FAIL_INDEX_FOUND 
CITRUSLEAF_FAIL_INDEX_NOTFOUND 
CITRUSLEAF_FAIL_INDEX_OOM 
CITRUSLEAF_FAIL_INDEX_NOTREADABLE 
CITRUSLEAF_FAIL_INDEX_GENERIC 
CITRUSLEAF_FAIL_INDEX_NAME_MAXLEN 
CITRUSLEAF_FAIL_INDEX_MAXCOUNT 
CITRUSLEAF_FAIL_QUERY_ABORTED 
CITRUSLEAF_FAIL_QUERY_QUEUEFULL 
CITRUSLEAF_FAIL_QUERY_TIMEOUT 
CITRUSLEAF_FAIL_QUERY_GENERIC 

Definition at line 64 of file cl_types.h.

Enumerator
CITRUSLEAF_FAIL_DC_DOWN 
CITRUSLEAF_FAIL_DC_UP 

Definition at line 155 of file cl_types.h.

Function Documentation

void citrusleaf_bins_free ( cl_bin bins,
int  n_bins 
)
int citrusleaf_copy_bins ( cl_bin **  destbins,
cl_bin srcbins,
int  n_bins 
)