All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Fields | Private Attributes | Related Functions
as_ldt Struct Reference

Detailed Description

Represents a bin containing an LDT value.

Definition at line 54 of file src/include/aerospike/as_ldt.h.

#include "as_ldt.h"

+ Collaboration diagram for as_ldt:

Data Fields

as_udf_module_name module
 
as_bin_name name
 
as_ldt_type type
 

Private Attributes

bool _free
 

Related Functions

(Note that these are not member functions.)

void as_ldt_destroy (as_ldt *ldt)
 
as_ldtas_ldt_init (as_ldt *ldt, const as_bin_name name, const as_ldt_type type, const as_udf_module_name module)
 
as_ldtas_ldt_new (const as_bin_name name, const as_ldt_type type, const as_udf_module_name module)
 

Friends And Related Function Documentation

void as_ldt_destroy ( as_ldt ldt)
related

Destroy the as_ldt, releasing resources.

Parameters
ldtThe as_ldt to destroy.
as_ldt * as_ldt_init ( as_ldt ldt,
const as_bin_name  name,
const as_ldt_type  type,
const as_udf_module_name  module 
)
related

Initialize a stack allocated as_ldt.

as_ldt ldt;
as_ldt_init(&ldt, "mystack", AS_LDT_LSTACK, NULL);

Use as_ldt_destroy() to release resources allocated to as_ldt via this function.

Parameters
ldtThe ldt to initialize.
nameThe name of the bin to contain the ldt.
typeThe type of ldt data to store in the bin.
moduleThe name of ldt customization module to use for this initialization.
Returns
The initialized as_ldt on success. Otherwise NULL.
as_ldt * as_ldt_new ( const as_bin_name  name,
const as_ldt_type  type,
const as_udf_module_name  module 
)
related

Creates and initializes a heap allocated as_ldt.

as_ldt * ldt = as_ldt_new("mystack", AS_LDT_LSTACK, NULL);

Use as_ldt_destroy() to release resources allocated to as_ldt via this function.

Parameters
nameThe name of the bin to contain the ldt.
typeThe type of ldt data to store in the bin.
moduleThe name of ldt customization module to use for this initialization.
Returns
The initialized as_key on success. Otherwise NULL.

Field Documentation

bool as_ldt::_free
private

If true, then as_ldt_destroy() will free this instance.

Definition at line 60 of file src/include/aerospike/as_ldt.h.

as_udf_module_name as_ldt::module

LDT UDF Module

Definition at line 75 of file src/include/aerospike/as_ldt.h.

as_bin_name as_ldt::name

Bin name.

Definition at line 65 of file src/include/aerospike/as_ldt.h.

as_ldt_type as_ldt::type

LDT Type.

Definition at line 70 of file src/include/aerospike/as_ldt.h.


The documentation for this struct was generated from the following files: