[][src]Module tarantool_module::c_api

Structs

AddrInfo
BoxFunctionCtx
BoxLatch

A lock for cooperative multitasking environment

BoxTupleFormat
BoxTupleIterator

Tuple iterator

SlabCache

Enums

SayLevel

Constants

BOX_CLUSTER_ID
BOX_FUNC_ID
BOX_ID_NIL
BOX_INDEX_ID
BOX_PRIV_ID
BOX_SCHEMA_ID
BOX_SPACE_ID
BOX_SYSTEM_ID_MAX
BOX_SYSTEM_ID_MIN
BOX_USER_ID
BOX_VFUNC_ID
BOX_VINDEX_ID
BOX_VPRIV_ID
BOX_VSPACE_ID
BOX_VUSER_ID

Statics

LOG_LEVEL
SAY_FN

Functions

box_error_clear

Clear the last error.

box_error_set

Set the last error.

box_latch_delete

Destroy and free the latch. \param latch latch

box_latch_lock

Lock a latch. Waits indefinitely until the current fiber can gain access to the latch.

box_latch_new

Allocate and initialize the new latch. \returns latch

box_latch_trylock

Try to lock a latch. Return immediately if the latch is locked. \param latch a latch \retval 0 - success \retval 1 - the latch is locked.

box_latch_unlock

Unlock a latch. The fiber calling this function must own the latch.

box_return_tuple

Return a Tuple from stored C procedure.

box_tuple_field

Return the raw Tuple field in MsgPack format.

box_tuple_format

Return the associated format. \param Tuple Tuple \return TupleFormat

box_tuple_format_default

Tuple Format.

box_tuple_iterator

Allocate and initialize a new Tuple iterator. The Tuple iterator allow to iterate over fields at root level of MsgPack array.

box_tuple_iterator_free

Destroy and free Tuple iterator

box_tuple_next

Return the next Tuple field from Tuple iterator. The returned buffer is valid until next call to box_tuple_* API.

box_tuple_position

Return zero-based next position in iterator. That is, this function return the field id of field that will be returned by the next call to box_tuple_next(it). Returned value is zero after initialization or rewind and box_tuple_field_count(Tuple) after the end of iteration.

box_tuple_rewind

Rewind iterator to the initial position.

box_tuple_seek

Seek the Tuple iterator.

box_tuple_update
box_tuple_upsert
clock_monotonic
clock_monotonic64
clock_process
clock_process64
clock_realtime
clock_realtime64
clock_thread
clock_thread64
coio_call

Create new eio task with specified function and arguments. Yield and wait until the task is complete or a timeout occurs.

coio_getaddrinfo

Fiber-friendly version of getaddrinfo(3).

cord_slab_cache

Return SlabCache suitable to use with tarantool/small library

Type Definitions

SayFunc