cntl.h

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2013 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_BUCKETNAME             0x30

#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

#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

typedef enum { LCB_LOG_TRACE = 0, LCB_LOG_DEBUG, LCB_LOG_INFO, LCB_LOG_WARN,
    LCB_LOG_ERROR, LCB_LOG_FATAL, LCB_LOG_MAX
} lcb_log_severity_t;

struct lcb_logprocs_st;

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);

typedef struct lcb_logprocs_st {
    int version;
    union { struct { lcb_logging_callback callback; } v0; } v;
} lcb_logprocs;

#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

typedef enum {
    LCB_SSL_ENABLED = 1 << 0, 
    LCB_SSL_NOVERIFY = 1 << 1 
} lcb_SSLOPTS;

#define LCB_CNTL_SSL_MODE 0x22

#define LCB_CNTL_SSL_CERT 0x23
/* For back compat */
#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 = 1 << 0, 
    LCB_RETRY_CMDS_SAFE = (1 << 1)|LCB_RETRY_CMDS_GET,

    LCB_RETRY_CMDS_ALL = (LCB_RETRY_CMDS_SAFE|LCB_RETRY_CMDS_GET)
} 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_DETAILED_ERRCODES 0x2A

#define LCB_CNTL_RETRY_INTERVAL 0x2C

#define LCB_CNTL_RETRY_BACKOFF 0x2D

#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__MAX                    0x33

#ifdef __cplusplus
}
#endif

#include "cntl-private.h"

#endif /* LCB_CNTL_H */