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

Go to the source code of this file.

Data Structures

struct  cl_udf_file
 
struct  cl_udf_info
 

Macros

#define AS_UDF_LUA   0
 

Typedefs

typedef uint8_t cl_udf_type
 

Functions

cl_rv citrusleaf_udf_get (cl_cluster *cluster, const char *filename, cl_udf_file *file, cl_udf_type udf_type, char **error)
 
cl_rv citrusleaf_udf_get_with_gen (cl_cluster *cluster, const char *filename, cl_udf_file *file, cl_udf_type udf_type, char **gen, char **error)
 
cl_rv citrusleaf_udf_list (cl_cluster *cluster, cl_udf_file **files, int *count, char **error)
 
cl_rv citrusleaf_udf_put (cl_cluster *cluster, const char *filename, as_bytes *content, cl_udf_type udf_type, char **error)
 
cl_rv citrusleaf_udf_record_apply (cl_cluster *cluster, const char *ns, const char *set, const cl_object *key, const char *filename, const char *function, as_list *arglist, int timeout, as_result *result)
 
cl_rv citrusleaf_udf_remove (cl_cluster *cluster, const char *filename, char **error)
 
void cl_udf_info_destroy (cl_udf_info *info)
 

Macro Definition Documentation

#define AS_UDF_LUA   0

Definition at line 41 of file cl_udf.h.

Typedef Documentation

typedef uint8_t cl_udf_type

Definition at line 47 of file cl_udf.h.

Function Documentation

cl_rv citrusleaf_udf_get ( cl_cluster *  cluster,
const char *  filename,
cl_udf_file file,
cl_udf_type  udf_type,
char **  error 
)
Parameters
filename- The name of the file to download from the cluster.
contents- The contents of the file. The contents must be freed by the user.
size- The size of the contents of the file.
error- Contains an error message, if the return value was non-zero. The value must be freed by the user.
cl_rv citrusleaf_udf_get_with_gen ( cl_cluster *  cluster,
const char *  filename,
cl_udf_file file,
cl_udf_type  udf_type,
char **  gen,
char **  error 
)
Parameters
filename- The name of the file to download from the cluster.
contents- The contents of the file. The value must be freed by the user.
size- The size of the contents of the file.
gen- The generation value of the file. The value must be freed by the user.
error- Contains an error message, if the return value was non-zero. The value must be freed by the user.
cl_rv citrusleaf_udf_list ( cl_cluster *  cluster,
cl_udf_file **  files,
int *  count,
char **  error 
)
Parameters
files- An array of filenames. Each entry is string. The array and each entry must be freed by the user.
count- Number of entries.
error- Contains an error message, if the return value was non-zero. The value must be freed by the user.
cl_rv citrusleaf_udf_put ( cl_cluster *  cluster,
const char *  filename,
as_bytes content,
cl_udf_type  udf_type,
char **  error 
)
Parameters
filename- The name of the file being uploaded to the cluster.
contents- The contents of the file being uploaded to the cluster.
error- Contains an error message, if the return value was non-zero. The value must be freed by the user.
cl_rv citrusleaf_udf_record_apply ( cl_cluster *  cluster,
const char *  ns,
const char *  set,
const cl_object key,
const char *  filename,
const char *  function,
as_list arglist,
int  timeout,
as_result result 
)

Apply a UDF to a record.

Parameters
resultwill be updated with the result of the call. The as_result.value member should be freed by the user.
cl_rv citrusleaf_udf_remove ( cl_cluster *  cluster,
const char *  filename,
char **  error 
)
Parameters
filename- The file to be removed from the cluster.
error- Contains an error message, if the return value was non-zero. The value must be freed by the user.
void cl_udf_info_destroy ( cl_udf_info info)