gauc 0.3.0

Couchbase Rust Adapter / CLI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2014 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_IOTABLE_H
#define LCB_IOTABLE_H

#include <libcouchbase/couchbase.h>

/**
 * @file
 * @brief Internal I/O Table routines
 *
 * @details
 * Include this file if you are actually manipulating the I/O system (i.e.
 * creating timers, starting/stoping loops, or writing to/from a socket).
 *
 * This file defines the iotable layout as well as various macros associated
 * with its use. The actual "Public" API (i.e. just for passing it around) can
 * be found in <lcbio/connect.h>
 */

#ifdef __cplusplus
extern "C" {
#endif

typedef struct lcbio_TABLE {
    lcb_io_opt_t p;
    lcb_iomodel_t model;
    lcb_timer_procs timer;
    lcb_loop_procs loop;

    union {
        struct {
            lcb_ev_procs ev;
            lcb_bsd_procs io;
        } v0;
        lcb_completion_procs completion;
    } u_io;
    unsigned refcount;
    void (*dtor)(void *);
} lcbio_TABLE;

/** Whether the underlying model is event-based */
#define IOT_IS_EVENT(iot) ((iot)->model == LCB_IOMODEL_EVENT)

/** Returns an lcb_ev_procs structure for event-based I/O */
#define IOT_V0EV(iot) (iot)->u_io.v0.ev

/** Returns an lcb_bsd_procs structure for event-based I/O */
#define IOT_V0IO(iot) (iot)->u_io.v0.io

/** Returns an lcb_completion_procs structure for completion-based I/O */
#define IOT_V1(iot) (iot)->u_io.completion

/** Error code of last I/O operation */
#define IOT_ERRNO(iot) (iot)->p->v.v0.error

/** Start the loop */
#define IOT_START(iot) (iot)->loop.start((iot)->p)

/** Stop the loop */
#define IOT_STOP(iot) (iot)->loop.stop((iot)->p)

/** First argument to IO Table */
#define IOT_ARG(iot) (iot)->p

#ifdef __cplusplus
}
#endif
#endif