libcouchbase 0.0.1

data/ext/libcouchbase/include/libcouchbase/plugins/io/wsaerr-inl.c

@@ -0,0 +1,76 @@
+/* -*- 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.
+ */
+
+#include "wsaerr.h"
+
+static int
+wsaerr_map_impl(DWORD in)
+{
+    switch (in) {
+    case WSAECONNRESET:
+        return ECONNRESET;
+
+    case WSAECONNABORTED:
+    case WSA_OPERATION_ABORTED:
+        return ECONNABORTED;
+
+    case WSA_NOT_ENOUGH_MEMORY:
+        return ENOMEM;
+
+    case WSAEWOULDBLOCK:
+    case WSA_IO_PENDING:
+        return EWOULDBLOCK;
+
+    case WSAEINVAL:
+        return EINVAL;
+
+    case WSAEINPROGRESS:
+        return EINPROGRESS;
+
+    case WSAEALREADY:
+        return EALREADY;
+
+    case WSAEISCONN:
+        return EISCONN;
+
+    case WSAENOTCONN:
+    case WSAESHUTDOWN:
+        return ENOTCONN;
+
+    case WSAECONNREFUSED:
+        return ECONNREFUSED;
+
+    case WSAEINTR:
+        return EINTR;
+
+
+    case WSAENETDOWN:
+    case WSAENETUNREACH:
+    case WSAEHOSTUNREACH:
+    case WSAEHOSTDOWN:
+        return ENETUNREACH;
+
+    case WSAETIMEDOUT:
+        return ETIMEDOUT;
+
+    case WSAENOTSOCK:
+        return ENOTSOCK;
+
+    default:
+        return EINVAL;
+    }
+}

data/ext/libcouchbase/include/libcouchbase/plugins/io/wsaerr.h

@@ -0,0 +1,199 @@
+/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2012 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 LIBCOUCHBASE_WIN_ERRNO_SOCK_H
+#define LIBCOUCHBASE_WIN_ERRNO_SOCK_H 1
+
+#include <errno.h>
+
+#ifndef EWOULDBLOCK
+#define EWOULDBLOCK             WSAEWOULDBLOCK
+#endif
+
+#ifndef EINPROGRESS
+#define EINPROGRESS             WSAEINPROGRESS
+#endif
+
+#ifndef EALREADY
+#define EALREADY                WSAEALREADY
+#endif
+
+#ifndef ENOTSOCK
+#define ENOTSOCK                WSAENOTSOCK
+#endif
+
+#ifndef EDESTADDRREQ
+#define EDESTADDRREQ            WSAEDESTADDRREQ
+#endif
+
+#ifndef EMSGSIZE
+#define EMSGSIZE                WSAEMSGSIZE
+#endif
+
+#ifndef EPROTOTYPE
+#define EPROTOTYPE              WSAEPROTOTYPE
+#endif
+
+#ifndef ENOPROTOOPT
+#define ENOPROTOOPT             WSAENOPROTOOPT
+#endif
+
+#ifndef EPROTONOSUPPORT
+#define EPROTONOSUPPORT         WSAEPROTONOSUPPORT
+#endif
+
+#ifndef ESOCKTNOSUPPORT
+#define ESOCKTNOSUPPORT         WSAESOCKTNOSUPPORT
+#endif
+
+#ifndef EOPNOTSUPP
+#define EOPNOTSUPP              WSAEOPNOTSUPP
+#endif
+
+#ifndef ENOPROTOOPT
+#define ENOPROTOOPT             WSAENOPROTOOPT
+#endif
+
+#ifndef EPROTONOSUPPORT
+#define EPROTONOSUPPORT         WSAEPROTONOSUPPORT
+#endif
+
+#ifndef ESOCKTNOSUPPORT
+#define ESOCKTNOSUPPORT         WSAESOCKTNOSUPPORT
+#endif
+
+#ifndef EPFNOSUPPORT
+#define EPFNOSUPPORT            WSAEPFNOSUPPORT
+#endif
+
+#ifndef EAFNOSUPPORT
+#define EAFNOSUPPORT            WSAEAFNOSUPPORT
+#endif
+
+#ifndef EADDRINUSE
+#define EADDRINUSE              WSAEADDRINUSE
+#endif
+
+#ifndef EADDRNOTAVAIL
+#define EADDRNOTAVAIL           WSAEADDRNOTAVAIL
+#endif
+
+#ifndef ENETDOWN
+#define ENETDOWN                WSAENETDOWN
+#endif
+
+#ifndef ENETUNREACH
+#define ENETUNREACH             WSAENETUNREACH
+#endif
+
+#ifndef ENETRESET
+#define ENETRESET               WSAENETRESET
+#endif
+
+#ifndef ECONNABORTED
+#define ECONNABORTED            WSAECONNABORTED
+#endif
+
+#ifndef ECONNRESET
+#define ECONNRESET              WSAECONNRESET
+#endif
+
+#ifndef ENOBUFS
+#define ENOBUFS                 WSAENOBUFS
+#endif
+
+#ifndef EISCONN
+#define EISCONN                 WSAEISCONN
+#endif
+
+#ifndef ENOTCONN
+#define ENOTCONN                WSAENOTCONN
+#endif
+
+#ifndef ESHUTDOWN
+#define ESHUTDOWN               WSAESHUTDOWN
+#endif
+
+#ifndef ETOOMANYREFS
+#define ETOOMANYREFS            WSAETOOMANYREFS
+#endif
+
+#ifndef ETIMEDOUT
+#define ETIMEDOUT               WSAETIMEDOUT
+#endif
+
+#ifndef ECONNREFUSED
+#define ECONNREFUSED            WSAECONNREFUSED
+#endif
+
+#ifndef ELOOP
+#define ELOOP                   WSAELOOP
+#endif
+
+/*
+#ifndef ENAMETOOLONG
+#define ENAMETOOLONG            WSAENAMETOOLONG
+#endif
+*/
+
+#ifndef EHOSTDOWN
+#define EHOSTDOWN               WSAEHOSTDOWN
+#endif
+
+#ifndef EHOSTUNREACH
+#define EHOSTUNREACH            WSAEHOSTUNREACH
+#endif
+
+/*
+#ifndef ENOTEMPTY
+#define ENOTEMPTY               WSAENOTEMPTY
+#endif
+*/
+
+#ifndef EPROCLIM
+#define EPROCLIM                WSAEPROCLIM
+#endif
+
+#ifndef EUSERS
+#define EUSERS                  WSAEUSERS
+#endif
+
+#ifndef EDQUOT
+#define EDQUOT                  WSAEDQUOT
+#endif
+
+#ifndef ESTALE
+#define ESTALE                  WSAESTALE
+#endif
+
+#ifndef EREMOTE
+#define EREMOTE                 WSAEREMOTE
+#endif
+
+#ifndef EPROTO
+#define EPROTO                  WSAEPROTONOSUPPORT
+#endif
+
+#ifndef ECANCELED
+#define ECANCELED               WSAECANCELLED
+#endif
+
+/** Some versions have this; some don't */
+#ifndef ENOTSUP
+#define ENOTSUP                 -1
+#endif
+
+#endif

data/ext/libcouchbase/include/libcouchbase/subdoc.h

@@ -0,0 +1,312 @@
+/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2016 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_SUBDOC_H
+#define LCB_SUBDOC_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**@ingroup lcb-public-api
+ * @defgroup lcb-subdoc Sub-Document API
+ * @brief Experimental in-document API access
+ * @details The sub-document API uses features from the upcoming Couchbase
+ * 4.5 release which allows access to parts of the document. These parts are
+ * called _sub-documents_ and can be accessed using the sub-document API
+ *
+ * @warning
+ * The sub-document API is experimental and subject to change and is here for
+ * demonstration purposes only.
+ *
+ * @addtogroup lcb-subdoc
+ * @{
+ */
+
+/**
+ * @brief Sub-Document command codes
+ *
+ * These command codes should be applied as values to lcb_SDSPEC::sdcmd and
+ * indicate which type of subdoc command the server should perform.
+ */
+typedef enum {
+    /**
+     * Retrieve the value for a path
+     */
+    LCB_SDCMD_GET = 1,
+
+    /**
+     * Check if the value for a path exists. If the path exists then the error
+     * code will be @ref LCB_SUCCESS
+     */
+    LCB_SDCMD_EXISTS,
+
+    /**
+     * Replace the value at the specified path. This operation can work
+     * on any existing and valid path.
+     */
+    LCB_SDCMD_REPLACE,
+
+    /**
+     * Add the value at the given path, if the given path does not exist.
+     * The penultimate path component must point to an array. The operation
+     * may be used in conjunction with @ref LCB_SDSPEC_F_MKINTERMEDIATES to
+     * create the parent dictionary (and its parents as well) if it does not
+     * yet exist.
+     */
+    LCB_SDCMD_DICT_ADD,
+
+    /**
+     * Unconditionally set the value at the path. This logically
+     * attempts to perform a @ref LCB_SDCMD_REPLACE, and if it fails, performs
+     * an @ref LCB_SDCMD_DICT_ADD.
+     */
+    LCB_SDCMD_DICT_UPSERT,
+
+    /**
+     * Prepend the value(s) to the array indicated by the path. The path should
+     * reference an array. When the @ref LCB_SDSPEC_F_MKINTERMEDIATES flag
+     * is specified then the array may be created if it does not exist.
+     *
+     * Note that it is possible to add more than a single value to an array
+     * in an operation (this is valid for this commnand as well as
+     * @ref LCB_SDCMD_ARRAY_ADD_LAST and @ref LCB_SDCMD_ARRAY_INSERT). Multiple
+     * items can be specified by placing a comma between then (the values should
+     * otherwise be valid JSON).
+     */
+    LCB_SDCMD_ARRAY_ADD_FIRST,
+
+    /**
+     * Identical to @ref LCB_SDCMD_ARRAY_ADD_FIRST but places the item(s)
+     * at the end of the array rather than at the beginning.
+     */
+    LCB_SDCMD_ARRAY_ADD_LAST,
+
+    /**
+     * Add the value to the array indicated by the path, if the value is not
+     * already in the array. The @ref LCB_SDSPEC_F_MKINTERMEDIATES flag can
+     * be specified to create the array if it does not already exist.
+     *
+     * Currently the value for this operation must be a JSON primitive (i.e.
+     * no arrays or dictionaries) and the existing array itself must also
+     * contain only primitives (otherwise a @ref LCB_SUBDOC_PATH_MISMATCH
+     * error will be received).
+     */
+    LCB_SDCMD_ARRAY_ADD_UNIQUE,
+
+    /**
+     * Add the value at the given array index. Unlike other array operations,
+     * the path specified should include the actual index at which the item(s)
+     * should be placed, for example `array[2]` will cause the value(s) to be
+     * the 3rd item(s) in the array.
+     *
+     * The array must already exist and the @ref LCB_SDCMD_F_MKINTERMEDIATES
+     * flag is not honored.
+     */
+    LCB_SDCMD_ARRAY_INSERT,
+
+    /**
+     * Increment or decrement an existing numeric path. If the number does
+     * not exist, it will be created (though its parents will not, unless
+     * @ref LCB_SDSPEC_F_MKINTERMEDIATES is specified).
+     *
+     * The value for this operation should be a valid JSON-encoded integer and
+     * must be between `INT64_MIN` and `INT64_MAX`, inclusive.
+     */
+    LCB_SDCMD_COUNTER,
+
+    /**
+     * Remove an existing path in the document.
+     */
+    LCB_SDCMD_REMOVE,
+
+    /**
+     * Count the number of elements in an array or dictionary
+     */
+    LCB_SDCMD_GET_COUNT,
+
+    LCB_SDCMD_MAX
+} lcb_SUBDOCOP;
+
+/**
+ * @brief Subdoc command specification.
+ * This structure describes an operation and its path, and possibly its value.
+ * This structure is provided in an array to the lcb_CMDSUBDOC::specs field.
+ */
+typedef struct {
+    /**
+     * The command code, @ref lcb_SUBDOCOP. There is no default for this
+     * value, and it therefore must be set.
+     */
+    lcb_U32 sdcmd;
+
+    /**
+     * Set of option flags for the command. Currently the only option known
+     * is @ref LCB_SDSPEC_F_MKINTERMEDIATES
+     */
+    lcb_U32 options;
+
+    /**
+     * Path for the operation. This should be assigned using
+     * @ref LCB_SDSPEC_SET_PATH. The contents of the path should be valid
+     * until the operation is scheduled (lcb_subdoc3())
+     */
+    lcb_KEYBUF path;
+
+    /**
+     * @value for the operation. This should be assigned using
+     * @ref LCB_SDSPEC_SET_VALUE. The contents of the value should be valid
+     * until the operation is scheduled (i.e. lcb_subdoc3())
+     */
+    lcb_VALBUF value;
+} lcb_SDSPEC;
+
+/** Create intermediate paths */
+#define LCB_SDSPEC_F_MKINTERMEDIATES (1<<16)
+
+/** Create document if it does not exist */
+#define LCB_SDSPEC_F_MKDOCUMENT (1<<17)
+
+/**
+ * Set the path for an @ref lcb_SDSPEC structure
+ * @param s pointer to spec
+ * @param p the path buffer
+ * @param n the length of the path buffer
+ */
+#define LCB_SDSPEC_SET_PATH(s, p, n) do { \
+    (s)->path.contig.bytes = p; \
+    (s)->path.contig.nbytes = n; \
+    (s)->path.type = LCB_KV_COPY; \
+} while (0);
+
+/**
+ * Set the value for the @ref lcb_SDSPEC structure
+ * @param s pointer to spec
+ * @param v the value buffer
+ * @param n the length of the value buffer
+ */
+#define LCB_SDSPEC_SET_VALUE(s, v, n) \
+    LCB_CMD_SET_VALUE(s, v, n)
+
+#define LCB_SDSPEC_INIT(spec, cmd_, path_, npath_, val_, nval_) do { \
+    (spec)->sdcmd = cmd_; \
+    LCB_SDSPEC_SET_PATH(spec, path_, npath_); \
+    LCB_CMD_SET_VALUE(spec, val_, nval_); \
+} while (0);
+
+#define LCB_SDMULTI_MODE_INVALID 0
+#define LCB_SDMULTI_MODE_LOOKUP 1
+#define LCB_SDMULTI_MODE_MUTATE 2
+typedef struct {
+    LCB_CMD_BASE;
+
+    /**
+     * An array of one or more command specifications. The storage
+     * for the array need only persist for the duration of the
+     * lcb_subdoc3() call.
+     *
+     * The specs array must be valid only through the invocation
+     * of lcb_subdoc3(). As such, they can reside on the stack and
+     * be re-used for scheduling multiple commands. See subdoc-simple.cc
+     */
+    const lcb_SDSPEC *specs;
+    /**
+     * Number of entries in #specs
+     */
+    size_t nspecs;
+    /**
+     * If the scheduling of the command failed, the index of the entry which
+     * caused the failure will be written to this pointer.
+     *
+     * If the value is -1 then the failure took place at the command level
+     * and not at the spec level.
+     */
+    int *error_index;
+    /**
+     * Operation mode to use. This can either be @ref LCB_SDMULTI_MODE_LOOKUP
+     * or @ref LCB_SDMULTI_MODE_MUTATE.
+     *
+     * This field may be left empty, in which case the mode is implicitly
+     * derived from the _first_ command issued.
+     */
+    lcb_U32 multimode;
+} lcb_CMDSUBDOC;
+
+/**
+ * Perform one or more subdocument operations.
+ */
+LIBCOUCHBASE_API
+lcb_error_t
+lcb_subdoc3(lcb_t instance, const void *cookie, const lcb_CMDSUBDOC *cmd);
+
+/**
+ * Response structure for multi lookups. If the top level response is successful
+ * then the individual results may be retrieved using lcb_sdmlookup_next()
+ */
+typedef struct {
+    LCB_RESP_BASE
+    const void *responses;
+    /** Use with lcb_backbuf_ref/unref */
+    void *bufh;
+} lcb_RESPSUBDOC;
+
+/**
+ * Structure for a single sub-document mutation or lookup result.
+ * Note that #value and #nvalue are only valid if #status is ::LCB_SUCCESS
+ */
+typedef struct {
+    /** Value for the mutation (only applicable for ::LCB_SUBDOC_COUNTER, currently) */
+    const void *value;
+    /** Length of the value */
+    size_t nvalue;
+    /** Status code */
+    lcb_error_t status;
+
+    /**
+     * Request index which this result pertains to. This field only
+     * makes sense for multi mutations where not all request specs are returned
+     * in the result
+     */
+    lcb_U8 index;
+} lcb_SDENTRY;
+
+/**
+ * Iterate over the results for a subdocument response.
+ *
+ * @warning
+ * This function _must_ be called from within the callback. The response itself
+ * may contain a pointer to internal stack data which is no longer valid
+ * once the callback exits.
+ *
+ * @param resp the response received from within the callback.
+ * @param[out] out structure to store the current result
+ * @param[in,out] iter internal iterator. First call should initialize this to 0
+ * Note that this value may be 0, in which case only the first response is
+ * returned.
+ *
+ * @return If this function returns nonzero then `out` will contain a valid
+ * entry. If this function returns 0 then `ent` is invalid and no more results
+ * remain for the response.
+ */
+LIBCOUCHBASE_API
+int
+lcb_sdresult_next(const lcb_RESPSUBDOC *resp, lcb_SDENTRY *out, size_t *iter);
+
+/**@}*/
+#ifdef __cplusplus
+}
+#endif
+#endif