kvbuf.h

Go to the documentation of this file.

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

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    LCB_KV_COPY = 0, 
    LCB_KV_CONTIG,   
    LCB_KV_IOV,      
    LCB_KV_VBID,

    LCB_KV_IOVCOPY,
} lcb_KVBUFTYPE;

#define LCB_KV_HEADER_AND_KEY LCB_KV_CONTIG

typedef struct lcb_CONTIGBUF {
    const void *bytes;
    size_t nbytes;
} lcb_CONTIGBUF;

typedef struct lcb_KEYBUF {
    lcb_KVBUFTYPE type;
    lcb_CONTIGBUF contig;
    lcb_U16 vbid; 
} lcb_KEYBUF;

#define LCB_KEYBUF_IS_EMPTY(k) (k)->contig.nbytes == 0

#define LCB_KREQ_SIMPLE(req, k, nk)                                                                                    \
    do {                                                                                                               \
        (req)->type = LCB_KV_COPY;                                                                                     \
        (req)->contig.bytes = k;                                                                                       \
        (req)->contig.nbytes = nk;                                                                                     \
    } while (0)

typedef struct lcb_FRAGBUF {
    lcb_IOV *iov;

    unsigned int niov;

    unsigned int total_length;
} lcb_FRAGBUF;

typedef struct lcb_VALBUF {
    lcb_KVBUFTYPE vtype;
    union {
        lcb_CONTIGBUF contig;
        lcb_FRAGBUF multi;
    } u_buf;
} lcb_VALBUF;

#ifdef __cplusplus
}
#endif
#endif