Couchbase C Client  2.7.7
cntl.h File Reference

Command codes for libcouchbase. More...

#include "cntl-private.h"

Go to the source code of this file.

Data Structures

struct  lcb_cntl_vbinfo_t
 Structure containing mapping information for a key. More...
 
struct  lcb_logprocs
 Logging context. More...
 
struct  lcb_cntl_vbinfo_t.v.v0
 v0 More...
 

Macros

#define LCB_CNTL_OP_TIMEOUT
 Operation Timeout. More...
 
#define LCB_CNTL_VIEW_TIMEOUT
 Views Timeout This is the I/O timeout for HTTP requests issues with LCB_HTTP_TYPE_VIEWS. More...
 
#define LCB_CNTL_N1QL_TIMEOUT
 N1QL Timeout This is the I/O timeout for N1QL queries, issued via lcb_n1ql_query() More...
 
#define LCB_CNTL_BUCKETNAME
 Get the name of the bucket This returns the name of the bucket this instance is connected to, or NULL if not yet connected to a bucket. More...
 
#define LCB_CNTL_BUCKETTYPE
 Get the bucket type. More...
 
#define LCB_CNTL_HANDLETYPE
 Get the handle type. More...
 
#define LCB_CNTL_VBCONFIG
 Get the vBucket handle. More...
 
#define LCB_CNTL_IOPS
 Get the iops implementation instance. More...
 
#define LCB_CNTL_VBMAP
 Get the vBucket ID for a given key, based on the current configuration. More...
 
#define LCB_CNTL_CONFERRTHRESH
 Configuration error threshold. More...
 
#define LCB_CNTL_DURABILITY_TIMEOUT
 Default timeout for lcb_durability_poll()This is the time the client will spend sending repeated probes to a given key's vBucket masters and replicas before they are deemed not to have satisfied the durability requirements. More...
 
#define LCB_CNTL_DURABILITY_INTERVAL
 Polling grace interval for lcb_durability_poll() More...
 
#define LCB_CNTL_HTTP_TIMEOUT
 Timeout for non-views HTTP requests. More...
 
#define LCB_CNTL_IOPS_DLOPEN_DEBUG
 Print verbose plugin load information to console. More...
 
#define LCB_CNTL_CONFIGURATION_TIMEOUT
 Initial bootstrap timeout. More...
 
#define LCB_CNTL_RANDOMIZE_BOOTSTRAP_HOSTS
 Randomize order of bootstrap nodes. More...
 
#define LCB_CNTL_CONFIG_CACHE_LOADED
 Determine if file-based configuration has been loaded. More...
 
#define LCB_CNTL_FORCE_SASL_MECH
 Force a specific SASL mechanism. More...
 
#define LCB_CNTL_MAX_REDIRECTS
 Maximum number of HTTP redirects to follow Set how many redirects the library should follow for the single request. More...
 
#define LCB_CNTL_CONFDELAY_THRESH
 Refresh Throttling. More...
 
#define LCB_CNTL_CONFIG_TRANSPORT
 Get the transport used to fetch cluster configuration. More...
 
#define LCB_CNTL_CONFIG_NODE_TIMEOUT
 Per-node configuration timeout. More...
 
#define LCB_CNTL_HTCONFIG_IDLE_TIMEOUT
 Idling/Persistence for HTTP bootstrap. More...
 
#define LCB_CNTL_CHANGESET
 Get the current SCM changeset for the library binary. More...
 
#define LCB_CNTL_CONFIGCACHE
 file used for the configuration cache. More...
 
#define LCB_CNTL_CONFIGCACHE_RO
 File used for read-only configuration cache. More...
 
#define LCB_CNTL_SSL_MODE
 Get SSL Mode. More...
 
#define LCB_CNTL_SSL_CERT
 Get SSL Certificate path. More...
 
#define LCB_CNTL_SSL_CACERT
 
#define LCB_RETRYOPT_CREATE(mode, policy)
 Create a retry setting value. More...
 
#define LCB_RETRYOPT_GETMODE(u)
 
#define LCB_RETRYOPT_GETPOLICY(u)
 
#define LCB_CNTL_RETRYMODE
 Set retry policies. More...
 
#define LCB_CNTL_HTCONFIG_URLTYPE
 Set the URL selection mode. More...
 
#define LCB_CNTL_SYNCDESTROY
 
#define LCB_CNTL_CONLOGGER_LEVEL
 
#define LCB_CNTL_CONLOGGER_FP
 
#define LCB_CNTL_DETAILED_ERRCODES
 
#define LCB_CNTL_RETRY_INTERVAL
 
#define LCB_CNTL_RETRY_BACKOFF
 
#define LCB_CNTL_RETRY_NMV_IMM
 
#define LCB_CNTL_HTTP_POOLSIZE
 
#define LCB_CNTL_HTTP_REFRESH_CONFIG_ON_ERROR
 uncommitted Determine whether or not a new configuration should be received when an error is received over the HTTP API (i.e. More...
 
#define LCB_CNTL_SCHED_IMPLICIT_FLUSH
 
#define LCB_CNTL_FETCH_MUTATION_TOKENS
 
#define LCB_CNTL_DURABILITY_MUTATION_TOKENS
 
#define LCB_CNTL_MUTATION_TOKENS_SUPPORTED
 
#define LCB_CNTL_RESET_TIMEOUT_ON_WAIT
 
#define LCB_CNTL_N1QL_CLEARACHE
 
#define LCB_CNTL_CLIENT_STRING
 
#define LCB_CNTL_BUCKET_CRED
 Set credentials for a bucket. More...
 
#define LCB_CNTL_RETRY_NMV_INTERVAL
 Set the amount of time the client should wait before retrying a not-my-vbucket response packet. More...
 
#define LCB_CNTL_READ_CHUNKSIZE
 Limit the number of bytes to be read (and thereby processed) during I/O read operations. More...
 
#define LCB_CNTL_ENABLE_ERRMAP
 Enable/Disable the Error Map feature. More...
 
#define LCB_CNTL_SELECT_BUCKET
 Enable/Disable sending the SELECT_BUCKET command after authentication. More...
 
#define LCB_CNTL_TCP_KEEPALIVE
 Enable/Disable setting the TCP_KEEPALIVE option on created sockets. More...
 
#define LCB_CNTL_CONFIG_POLL_INTERVAL
 Set the amount of time to wait in between polling for a new configuration. More...
 
#define LCB_CNTL_SEND_HELLO
 From version 2.7.4, the C library sends a HELLO command before authentication. More...
 
#define LCB_CNTL__MAX
 This is not a command, but rather an indicator of the last item.
 
Modes

Modes for the lcb_cntl() mode argument

#define LCB_CNTL_SET
 Modify a setting.
 
#define LCB_CNTL_GET
 Retrieve a setting.
 

Typedefs

typedef const char * lcb_BUCKETCRED[2]
 

Enumerations

enum  lcb_SSLOPTS
 
enum  lcb_RETRYMODEOPTS
 Select retry mode to manipulate. More...
 
enum  lcb_RETRYCMDOPTS
 
enum  lcb_HTCONFIG_URLTYPE
 Enumeration representing various URL forms to use for the configuration stream. More...
 

Logging

Verbose logging may be enabled by default using the environment variable LCB_LOGLEVEL and setting it to a number > 1; higher values produce more verbose output.

The maximum level is 5.

You may also install your own logger using lcb_cntl() and the LCB_CNTL_LOGGER constant. Note that the logger functions will not be called rapidly from within hot paths.

#define LCB_CNTL_LOGGER
 Access the lcb_logprocs structure. More...
 
enum  lcb_log_severity_t
 Logging Levels.
 
typedef void(* lcb_logging_callback) (struct lcb_logprocs_st *procs, unsigned int iid, const char *subsys, int severity, const char *srcfile, int srcline, const char *fmt, va_list ap)
 Logger callback. More...
 

Detailed Description

Command codes for libcouchbase.

These codes may be passed to 'lcb_cntl'.

Note that the constant values are also public API; thus allowing forwards and backwards compatibility.