cntl.h

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2017-2020 Couchbase, Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
 
#ifndef LCB_CNTL_H
#define LCB_CNTL_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define LCB_CNTL_SET 0x01 
#define LCB_CNTL_GET 0x00 
#define LCB_CNTL_OP_TIMEOUT 0x00
 
#define LCB_CNTL_VIEW_TIMEOUT 0x01
 
#define LCB_CNTL_QUERY_TIMEOUT 0x3D
 
#define LCB_CNTL_BUCKETNAME 0x30
 
#define LCB_CNTL_BUCKETTYPE 0x48
 
#define LCB_CNTL_HANDLETYPE 0x04
 
#define LCB_CNTL_VBCONFIG 0x05
 
#define LCB_CNTL_IOPS 0x06
 
typedef struct lcb_cntl_vbinfo_st {
    int version;
 
    union {
        struct {
            const void *key;  
            lcb_SIZE nkey;    
            int vbucket;      
            int server_index; 
        } v0;
    } v;
} lcb_cntl_vbinfo_t;
 
#define LCB_CNTL_VBMAP 0x07
 
typedef enum {
    LCB_IPV6_DISABLED = 0x00, 
    LCB_IPV6_ONLY = 0x1,      
    LCB_IPV6_ALLOW = 0x02     
} lcb_ipv6_t;
 
#define LCB_CNTL_IP6POLICY 0x0b
 
#define LCB_CNTL_CONFERRTHRESH 0x0c
 
#define LCB_CNTL_DURABILITY_TIMEOUT 0x0d
 
#define LCB_CNTL_DURABILITY_INTERVAL 0x0e
 
#define LCB_CNTL_HTTP_TIMEOUT 0x0f
 
#define LCB_CNTL_IOPS_DLOPEN_DEBUG 0x11
 
#define LCB_CNTL_CONFIGURATION_TIMEOUT 0x12
 
#define LCB_CNTL_RANDOMIZE_BOOTSTRAP_HOSTS 0x14
 
#define LCB_CNTL_CONFIG_CACHE_LOADED 0x15
 
#define LCB_CNTL_FORCE_SASL_MECH 0x16
 
#define LCB_CNTL_MAX_REDIRECTS 0x17
 
#define LCB_CNTL_LOGGER 0x18
 
#define LCB_CNTL_CONFDELAY_THRESH 0x19
 
#define LCB_CNTL_CONFIG_TRANSPORT 0x1A
 
#define LCB_CNTL_CONFIG_NODE_TIMEOUT 0x1B
 
#define LCB_CNTL_HTCONFIG_IDLE_TIMEOUT 0x1C
 
#define LCB_CNTL_CHANGESET 0x1F
 
#define LCB_CNTL_CONFIGCACHE 0x21
 
#define LCB_CNTL_CONFIGCACHE_RO 0x36
 
typedef enum {
    LCB_SSL_ENABLED = 1 << 0,     
    LCB_SSL_NOVERIFY = 1 << 1,    
    LCB_SSL_NOGLOBALINIT = 1 << 2 
} lcb_SSLOPTS;
 
#define LCB_CNTL_SSL_MODE 0x22
 
#define LCB_CNTL_SSL_CERT 0x23
 
#define LCB_CNTL_SSL_KEY 0x4b
 
#define LCB_CNTL_SSL_TRUSTSTORE 0x4d
 
#define LCB_CNTL_SSL_CACERT LCB_CNTL_SSL_CERT
 
typedef enum {
    LCB_RETRY_ON_TOPOCHANGE = 0, 
    LCB_RETRY_ON_SOCKERR,        
    LCB_RETRY_ON_VBMAPERR,       
    LCB_RETRY_ON_MISSINGNODE,
    LCB_RETRY_ON_MAX 
} lcb_RETRYMODEOPTS;
 
typedef enum {
    LCB_RETRY_CMDS_NONE = 0,
 
    LCB_RETRY_CMDS_GET = 0x01,
 
    LCB_RETRY_CMDS_SAFE = 0x03, /* Includes 'GET', plus a new flag (e.g. 0x02|0x01) */
 
    LCB_RETRY_CMDS_ALL = 0x07 /* e.g. 0x01|0x03| NEW FLAG: 0x04 */
} lcb_RETRYCMDOPTS;
 
#define LCB_RETRYOPT_CREATE(mode, policy) (((mode) << 16) | policy)
 
#define LCB_RETRYOPT_GETMODE(u) ((u) >> 16)
#define LCB_RETRYOPT_GETPOLICY(u) ((u)&0xffff)
 
#define LCB_CNTL_RETRYMODE 0x24
 
typedef enum {
    LCB_HTCONFIG_URLTYPE_25PLUS = 0x01,
 
    LCB_HTCONFIG_URLTYPE_COMPAT = 0x02,
 
    LCB_HTCONFIG_URLTYPE_TRYALL = 0x03
} lcb_HTCONFIG_URLTYPE;
 
#define LCB_CNTL_HTCONFIG_URLTYPE 0x25
 
#define LCB_CNTL_SYNCDESTROY 0x28
 
#define LCB_CNTL_CONLOGGER_LEVEL 0x29
 
#define LCB_CNTL_CONLOGGER_FP 0x3B
 
#define LCB_CNTL_DETAILED_ERRCODES 0x2A
 
#define LCB_CNTL_RETRY_INTERVAL 0x2C
 
#define LCB_CNTL_RETRY_NMV_IMM 0x37
 
#define LCB_CNTL_HTTP_POOLSIZE 0x2E
 
#define LCB_CNTL_HTTP_REFRESH_CONFIG_ON_ERROR 0x2F
 
#define LCB_CNTL_SCHED_IMPLICIT_FLUSH 0x31
 
#define LCB_CNTL_ENABLE_MUTATION_TOKENS 0x34
 
#define LCB_CNTL_MUTATION_TOKENS_SUPPORTED 0x38
 
#define LCB_CNTL_RESET_TIMEOUT_ON_WAIT 0x3A
 
#define LCB_CNTL_QUERY_CLEARACHE 0x3E
 
#define LCB_CNTL_CLIENT_STRING 0x3F
 
typedef const char *lcb_BUCKETCRED[2];
 
#define LCB_CNTL_BUCKET_CRED 0x40
 
#define LCB_CNTL_RETRY_NMV_INTERVAL 0x41
 
#define LCB_CNTL_READ_CHUNKSIZE 0x42
 
#define LCB_CNTL_SELECT_BUCKET 0x44
 
#define LCB_CNTL_TCP_KEEPALIVE 0x45
 
#define LCB_CNTL_CONFIG_POLL_INTERVAL 0x46
 
#define LCB_CNTL_LOG_REDACTION 0x4c
 
#define LCB_CNTL_ENABLE_TRACING 0x4e
 
typedef enum {
    LCBTRACE_THRESHOLD_KV = 0,
    LCBTRACE_THRESHOLD_QUERY,
    LCBTRACE_THRESHOLD_VIEW,
    LCBTRACE_THRESHOLD_SEARCH,
    LCBTRACE_THRESHOLD_ANALYTICS,
    LCBTRACE_THRESHOLD__MAX
} lcbtrace_THRESHOLDOPTS;
 
#define LCB_CNTL_TRACING_ORPHANED_QUEUE_FLUSH_INTERVAL 0x4f
 
#define LCB_CNTL_TRACING_ORPHANED_QUEUE_SIZE 0x50
 
#define LCB_CNTL_TRACING_THRESHOLD_QUEUE_FLUSH_INTERVAL 0x51
 
#define LCB_CNTL_TRACING_THRESHOLD_QUEUE_SIZE 0x52
 
#define LCB_CNTL_TRACING_THRESHOLD_KV 0x53
 
#define LCB_CNTL_TRACING_THRESHOLD_QUERY 0x54
 
#define LCB_CNTL_TRACING_THRESHOLD_VIEW 0x55
 
#define LCB_CNTL_TRACING_THRESHOLD_SEARCH 0x56
 
#define LCB_CNTL_TRACING_THRESHOLD_ANALYTICS 0x57
 
typedef enum {
    LCB_COMPRESS_NONE = 0x00,
 
    LCB_COMPRESS_IN = 1 << 0,
 
    LCB_COMPRESS_OUT = 1 << 1,
 
    LCB_COMPRESS_INOUT = (LCB_COMPRESS_IN | LCB_COMPRESS_OUT),
 
    LCB_COMPRESS_FORCE = 1 << 2
} lcb_COMPRESSOPTS;
 
#define LCB_CNTL_COMPRESSION_OPTS 0x26
 
#define LCB_CNTL_COMPRESSION_MIN_SIZE 0x58
 
#define LCB_CNTL_COMPRESSION_MIN_RATIO 0x59
 
#define LCB_CNTL_NETWORK 0x5b
 
#define LCB_CNTL_HTTP_POOL_TIMEOUT 0x5d
 
#define LCB_CNTL_ENABLE_COLLECTIONS 0x4a
 
#define LCB_CNTL_ENABLE_DURABLE_WRITE 0x5e
 
#define LCB_CNTL_PERSISTENCE_TIMEOUT_FLOOR 0x5f
 
#define LCB_CNTL_ALLOW_STATIC_CONFIG 0x60
 
#define LCB_CNTL_ANALYTICS_TIMEOUT 0x61
 
#define LCB_CNTL_ENABLE_UNORDERED_EXECUTION 0x62
 
#define LCB_CNTL_SEARCH_TIMEOUT 0x63
 
#define LCB_CNTL_ENABLE_ERRMAP 0x65
 
#define LCB_CNTL_OP_METRICS_FLUSH_INTERVAL 0x66
 
#define LCB_CNTL_ENABLE_OP_METRICS 0x67
 
#define LCB_CNTL__MAX 0x68
#ifdef __cplusplus
}
#endif
 
#include "cntl-private.h"
 
#endif /* LCB_CNTL_H */