Volatile Interfaces

See also

Interface Attributes

Page Environment Variables

globalScope> Global LCB_CMD__SETVBID (cmd, vbid)

Global lcb_CMDBASE::_hashkey

Global lcb_CMDCOUNTER::_hashkey

Global lcb_CMDENDURE::_hashkey

Global lcb_CMDGET::_hashkey

Global lcb_CMDGETREPLICA::_hashkey

Global lcb_CMDHTTP::_hashkey

Global lcb_CMDOBSEQNO::_hashkey

Global lcb_CMDOBSERVE::_hashkey

Global lcb_CMDSTORE::_hashkey

Global lcb_CMDSTOREDUR::_hashkey

globalScope> Global LCB_CNTL_DURABILITY_MUTATION_TOKENS

globalScope> Global LCB_CNTL_FETCH_MUTATION_TOKENS

globalScope> Global LCB_CNTL_HTCONFIG_IDLE_TIMEOUT

globalScope> Global LCB_CNTL_HTCONFIG_URLTYPE

- Primarily here to support tests and buggy HTTP servers/proxies which do not like to maintain a connection upon receipt of a 404.

globalScope> Global LCB_CNTL_HTTP_POOLSIZE

globalScope> Global LCB_CNTL_IOPS_DLOPEN_DEBUG

globalScope> Global LCB_CNTL_KVTIMINGS

Get the lcb_HISTOGRAM object for key-value timings

Argument

Modes	Arg
Get	lcb_HISTOGRAM**

globalScope> Global LCB_CNTL_MUTATION_TOKENS_SUPPORTED

globalScope> Global LCB_CNTL_N1QL_CLEARACHE

Clears the internal prepared statement cache for N1QL

globalScope> Global LCB_CNTL_RDBALLOCFACTORY

Set the allocator factory used by libcouchbase. The allocator factory is a function invoked with no arguments which yields a new rdb_ALLOCATOR object. Currently the use and API of this object is considered internal and its API and header files are in src/rdb.

globalScope> Global LCB_CNTL_RETRY_NMV_IMM

Whether commands are retried immediately upon receipt of not-my-vbucket replies.

globalScope> Global LCB_CNTL_RETRYMODE

globalScope> Global LCB_CNTL_SCHED_IMPLICIT_FLUSH

Set the behavior of the lcb_sched_leave() API call. By default the lcb_sched_leave() will also set up the necessary requirements for flushing to the network. If this option is off then an explicit call to lcb_sched_flush() must be performed instead.

globalScope> Global LCB_CNTL_SYNCDESTROY

Determines whether to run the event loop internally within lcb_destroy() until no more I/O resources remain for the library. This is usually only necessary if you are creating a lot of instances and/or are using memory leak analysis tools.

globalScope> Global LCB_CNTL_TCP_NODELAY

Disable or enable Nagle's algorithm. The default is to disable it, as it will typically reduce latency. In general it is recommended not to touch this setting. It is here mainly for debugging.

globalScope> Global LCB_CNTL_UNSAFE_OPTIMIZE

This is a collection of various options which sacrifice data safety for speed.

globalScope> Global LCB_CNTL_VBGUESS_PERSIST

globalScope> Global lcb_dump (lcb_t instance, FILE *fp, lcb_U32 flags)

globalScope> Global lcb_flush3 (lcb_t instance, const void *cookie, const lcb_CMDFLUSH *cmd)

globalScope> Global lcb_get_mutation_token (lcb_t instance, const lcb_KEYBUF *kb, lcb_error_t *errp)

globalScope> Global lcb_iops_wire_bsd_impl2 (lcb_bsd_procs *procs, int version)

globalScope> Global lcb_n1ql_query (lcb_t instance, const void *cookie, const lcb_CMDN1QL *cmd)

globalScope> Global lcb_observe_seqno3 (lcb_t instance, const void *cookie, const lcb_CMDOBSEQNO *cmd)

globalScope> Global lcb_server_verbosity3 (lcb_t instance, const void *cookie, const lcb_CMDVERBOSITY *cmd)

globalScope> Global lcb_server_versions3 (lcb_t instance, const void *cookie, const lcb_CMDBASE *cmd)

globalScope> Global lcb_storedur3 (lcb_t instance, const void *cookie, const lcb_CMDSTOREDUR *cmd)

globalScope> Global lcb_tick_nowait (lcb_t instance)

This function will cause a single "tick" in the underlying event loop, causing operations whose I/O can be executed immediately to be sent to the server.

globalScope> Global lcb_view_cancel (lcb_t instance, lcb_VIEWHANDLE handle)

globalScope> Global lcb_view_query (lcb_t instance, const void *cookie, const lcb_CMDVIEWQUERY *cmd)

globalScope> Global lcb_view_query_initcmd (lcb_CMDVIEWQUERY *vq, const char *design, const char *view, const char *options, lcb_VIEWQUERYCALLBACK callback)

globalScope> Global lcbvb_compare (lcbvb_CONFIG *from, lcbvb_CONFIG *to)

Class lcbvb_CONFIG

. ABI/API compatibility not guaranteed between versions.

Class lcbvb_CONTINUUM

globalScope> Global lcbvb_genconfig (lcbvb_CONFIG *vb, unsigned nservers, unsigned nreplica, unsigned nvbuckets)

globalScope> Global lcbvb_genconfig_ex (lcbvb_CONFIG *vb, const char *name, const char *uuid, const lcbvb_SERVER *servers, unsigned nservers, unsigned nreplica, unsigned nvbuckets)

globalScope> Global lcbvb_make_ketama (lcbvb_CONFIG *vb)

Convert the configuration to a ketama one.

Parameters

vb	The configuration object.

globalScope> Global lcbvb_replace_host (lcbvb_CONFIG *cfg, const char *hostname)

globalScope> Global lcbvb_save_json (lcbvb_CONFIG *vbc)

Serialize the current configuration as a JSON string. The string returned is NUL-terminated and should be freed using the free() function.

Class lcbvb_SERVER

. ABI/API compatibility not guaranteed between versions.

Class lcbvb_SERVICES

. ABI/API compatibility not guaranteed between versions

globalScope> Global lcbvb_vbserver (cfg, vbid, ix)

This allows to get the given index for a vbucket server. If the index is 0 then this returns the master index, if the index is greater then it returns the replica index

Class lcbvb_VBUCKET

. ABI/API compatibility not guaranteed between versions