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

Go to the source code of this file.

Data Structures

struct  as_udf_call
 
struct  as_udf_file
 
struct  as_udf_files
 

Macros

#define AS_UDF_FILE_HASH_SIZE   (20 * 2)
 
#define AS_UDF_FILE_NAME_LEN   AS_UDF_FILE_NAME_SIZE - 1
 
#define AS_UDF_FILE_NAME_SIZE   128
 
#define AS_UDF_FILE_NAME_SIZE   128
 
#define AS_UDF_FUNCTION_MAX_LEN   (AS_UDF_FUNCTION_MAX_SIZE - 1)
 
#define AS_UDF_FUNCTION_MAX_SIZE   64
 
#define AS_UDF_MODULE_MAX_LEN   (AS_UDF_MODULE_MAX_SIZE - 1)
 
#define AS_UDF_MODULE_MAX_SIZE   64
 

Typedefs

typedef char as_udf_function_name [AS_UDF_FUNCTION_MAX_SIZE]
 
typedef char as_udf_module_name [AS_UDF_MODULE_MAX_SIZE]
 

Enumerations

enum  as_udf_type { AS_UDF_TYPE_LUA }
 

Functions

AS_EXTERN void as_udf_call_destroy (as_udf_call *call)
 
AS_EXTERN as_udf_callas_udf_call_init (as_udf_call *call, const as_udf_module_name module, const as_udf_function_name function, as_list *arglist)
 
AS_EXTERN as_udf_callas_udf_call_new (const as_udf_module_name module, const as_udf_function_name function, as_list *arglist)
 
AS_EXTERN void as_udf_file_destroy (as_udf_file *file)
 
AS_EXTERN as_udf_fileas_udf_file_init (as_udf_file *file)
 
AS_EXTERN as_udf_fileas_udf_file_new (void)
 
AS_EXTERN void as_udf_files_destroy (as_udf_files *files)
 
AS_EXTERN as_udf_filesas_udf_files_init (as_udf_files *files, uint32_t capacity)
 
AS_EXTERN as_udf_filesas_udf_files_new (uint32_t capacity)
 

Macro Definition Documentation

#define AS_UDF_FILE_HASH_SIZE   (20 * 2)

The size of a UDF hash value

Definition at line 68 of file as_udf.h.

#define AS_UDF_FILE_NAME_LEN   AS_UDF_FILE_NAME_SIZE - 1

The maxium string length of the UDF file name

Definition at line 63 of file as_udf.h.

#define AS_UDF_FILE_NAME_SIZE   128

The size of a UDF file name

Definition at line 58 of file as_udf.h.

#define AS_UDF_FILE_NAME_SIZE   128

The size of a UDF file name

Definition at line 58 of file as_udf.h.

#define AS_UDF_FUNCTION_MAX_LEN   (AS_UDF_FUNCTION_MAX_SIZE - 1)

Maximum number of chars allows in UDF function name.

Definition at line 48 of file as_udf.h.

#define AS_UDF_FUNCTION_MAX_SIZE   64

Maximum number of bytes in UDF module name.

Definition at line 43 of file as_udf.h.

#define AS_UDF_MODULE_MAX_LEN   (AS_UDF_MODULE_MAX_SIZE - 1)

Maximum number of chars allows in UDF module name.

Definition at line 38 of file as_udf.h.

#define AS_UDF_MODULE_MAX_SIZE   64

Maximum number of bytes in UDF module name.

Definition at line 33 of file as_udf.h.

Typedef Documentation

typedef char as_udf_function_name[AS_UDF_FUNCTION_MAX_SIZE]

UDF Function Name

Definition at line 82 of file as_udf.h.

typedef char as_udf_module_name[AS_UDF_MODULE_MAX_SIZE]

UDF Module Name

Definition at line 77 of file as_udf.h.

Enumeration Type Documentation

Enumeration of UDF types

Enumerator
AS_UDF_TYPE_LUA 

Lua

Definition at line 115 of file as_udf.h.

Function Documentation

AS_EXTERN void as_udf_call_destroy ( as_udf_call call)

Destroy an as_udf_call.

AS_EXTERN as_udf_call* as_udf_call_init ( as_udf_call call,
const as_udf_module_name  module,
const as_udf_function_name  function,
as_list arglist 
)

Initialize a stack allocated as_udf_call.

Parameters
callThe call to initialize.
moduleThe UDF module.
functionThe UDF function.
arglistThe UDF argument list.
Returns
The initialized call on success. Otherwise NULL.
AS_EXTERN as_udf_call* as_udf_call_new ( const as_udf_module_name  module,
const as_udf_function_name  function,
as_list arglist 
)

Creates a new heap allocated as_udf_call.

Parameters
moduleThe UDF module.
functionThe UDF function.
arglistThe UDF argument list.
Returns
The newly allocated call on success. Otherwise NULL.
AS_EXTERN void as_udf_file_destroy ( as_udf_file file)

Destroy an as_udf_file.

AS_EXTERN as_udf_file* as_udf_file_init ( as_udf_file file)

Initialize a stack allocated as_udf_file.

Returns
The initialized udf file on success. Otherwise NULL.
AS_EXTERN as_udf_file* as_udf_file_new ( void  )

Creates a new heap allocated as_udf_file.

Returns
The newly allocated udf file on success. Otherwise NULL.
AS_EXTERN void as_udf_files_destroy ( as_udf_files files)

Destroy an as_udf_files.

AS_EXTERN as_udf_files* as_udf_files_init ( as_udf_files files,
uint32_t  capacity 
)

Initialize a stack allocated as_udf_files.

Returns
The initialized udf list on success. Otherwise NULL.
AS_EXTERN as_udf_files* as_udf_files_new ( uint32_t  capacity)

Creates a new heap allocated as_udf_files.

Returns
The newly allocated udf list on success. Otherwise NULL.