mt-libcouchbase 1.4.0

data/lib/mt-libcouchbase/ext/mt-libcouchbase/fragbuf.rb

@@ -0,0 +1,18 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :iov ::
+  #   (FFI::Pointer(*IOV)) An IOV array
+  # :niov ::
+  #   (Integer) Number of elements in iov array
+  # :total_length ::
+  #   (Integer) Total length of the items. This should be set, if known, to prevent the
+  #   library from manually traversing the iov array to calculate the length.
+  class FRAGBUF < FFI::Struct
+    layout :iov, :pointer,
+           :niov, :uint,
+           :total_length, :uint
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/ftshandle.rb

@@ -0,0 +1,7 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  class FTSHANDLE < FFI::Struct
+    layout :dummy, :char
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/histogram.rb

@@ -0,0 +1,34 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  module HISTOGRAMWrappers
+    # @return [nil]
+    def destroy()
+      MTLibcouchbase::Ext.histogram_destroy(self)
+    end
+
+    # @param [Integer] duration
+    # @return [nil]
+    def record(duration)
+      MTLibcouchbase::Ext.histogram_record(self, duration)
+    end
+
+    # @param [FFI::Pointer(*Void)] cookie
+    # @param [Proc(callback_histogram_callback)] cb
+    # @return [nil]
+    def read(cookie, cb)
+      MTLibcouchbase::Ext.histogram_read(self, cookie, cb)
+    end
+
+    # @param [FFI::Pointer(*FILE)] stream
+    # @return [nil]
+    def print(stream)
+      MTLibcouchbase::Ext.histogram_print(self, stream)
+    end
+  end
+
+  class HISTOGRAM < FFI::Struct
+    include HISTOGRAMWrappers
+    layout :dummy, :char
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/http_request_t.rb

@@ -0,0 +1,7 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  class HttpRequestT < FFI::Struct
+    layout :dummy, :char
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/keybuf.rb

@@ -0,0 +1,20 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :type ::
+  #   (KVBUFTYPE) The type of key to provide. This can currently be LCB_KV_COPY (Default)
+  #   to copy the key into the pipeline buffers, or LCB_KV_HEADER_AND_KEY
+  #   to provide a buffer with the header storage and the key.
+  #
+  #   TODO:
+  #   Currently only LCB_KV_COPY should be used. LCB_KV_HEADER_AND_KEY is used
+  #   internally but may be exposed later on
+  # :contig ::
+  #   (CONTIGBUF)
+  class KEYBUF < FFI::Struct
+    layout :type, KVBUFTYPE,
+           :contig, CONTIGBUF.by_value
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/multicmd_ctx.rb

@@ -0,0 +1,30 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :addcmd ::
+  #   (FFI::Pointer(*)) Add a command to the current context
+  #   @param ctx the context
+  #   @param cmd the command to add. Note that `cmd` may be a subclass of lcb_CMDBASE
+  #   @return LCB_SUCCESS, or failure if a command could not be added.
+  # :done ::
+  #   (FFI::Pointer(*)) Indicate that no more commands are added to this context, and that the
+  #   context should assemble the packets and place them in the current
+  #   scheduling context
+  #   @param ctx The multi context
+  #   @param cookie The cookie for all commands
+  #   @return LCB_SUCCESS if scheduled successfully, or an error code if there
+  #   was a problem constructing the packet(s).
+  # :fail ::
+  #   (FFI::Pointer(*)) Indicate that no more commands should be added to this context, and that
+  #   the context should not add its contents to the packet queues, but rather
+  #   release its resources. Called if you don't want to actually perform
+  #   the operations.
+  #   @param ctx
+  class MULTICMDCTX < FFI::Struct
+    layout :addcmd, :pointer,
+           :done, :pointer,
+           :fail, :pointer
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/mutation_token.rb

@@ -0,0 +1,17 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :uuid ::
+  #   (Integer) < Use LCB_MUTATION_TOKEN_ID()
+  # :seqno ::
+  #   (Integer) < Use LCB_MUTATION_TOKEN_SEQ()
+  # :vbid ::
+  #   (Integer) < Use LCB_MUTATION_TOKEN_VB()
+  class MUTATIONTOKEN < FFI::Struct
+    layout :uuid, :ulong_long,
+           :seqno, :ulong_long,
+           :vbid, :ushort
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/n1qlhandle.rb

@@ -0,0 +1,7 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  class N1QLHANDLE < FFI::Struct
+    layout :dummy, :char
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/n1qlparams.rb

@@ -0,0 +1,7 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  class N1QLPARAMS < FFI::Struct
+    layout :dummy, :char
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respbase.rb

@@ -0,0 +1,29 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  class RESPBASE < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respcounter.rb

@@ -0,0 +1,32 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :value ::
+  #   (Integer) Contains the _current_ value after the operation was performed
+  class RESPCOUNTER < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :value, :ulong_long
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respendure.rb

@@ -0,0 +1,49 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :nresponses ::
+  #   (Integer) Total number of polls (i.e. how many packets per server) did this
+  #   operation require
+  # :exists_master ::
+  #   (Integer) Whether this item exists in the master in its current form. This can be
+  #   true even if #rc is not successful
+  # :persisted_master ::
+  #   (Integer) True if item was persisted on the master node. This may be true even if
+  #   #rc is not successful.
+  # :npersisted ::
+  #   (Integer) Total number of nodes (including master) on which this mutation has
+  #   been persisted. Valid even if #rc is not successful.
+  # :nreplicated ::
+  #   (Integer) Total number of replica nodes to which this mutation has been replicated.
+  #   Valid even if #rc is not successful.
+  class RESPENDURE < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :nresponses, :ushort,
+           :exists_master, :uchar,
+           :persisted_master, :uchar,
+           :npersisted, :uchar,
+           :nreplicated, :uchar
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respfts.rb

@@ -0,0 +1,40 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :row ::
+  #   (String) A query hit, or response metadta
+  #   (if #rflags contains @ref LCB_RESP_F_FINAL). The format of the row will
+  #   be JSON, and should be decoded by a JSON decoded in your application.
+  # :nrow ::
+  #   (Integer) Length of #row
+  # :htresp ::
+  #   (RESPHTTP) Original HTTP response obejct
+  class RESPFTS < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :row, :pointer,
+           :nrow, :ulong,
+           :htresp, RESPHTTP.by_ref
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respget.rb

@@ -0,0 +1,44 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :value ::
+  #   (FFI::Pointer(*Void)) < Value buffer for the item
+  # :nvalue ::
+  #   (Integer) < Length of value
+  # :bufh ::
+  #   (FFI::Pointer(*Void))
+  # :datatype ::
+  #   (Integer) < @private
+  # :itmflags ::
+  #   (Integer) < User-defined flags for the item
+  class RESPGET < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :value, :pointer,
+           :nvalue, :ulong,
+           :bufh, :pointer,
+           :datatype, :uchar,
+           :itmflags, :uint
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/resphttp.rb

@@ -0,0 +1,48 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :htstatus ::
+  #   (Integer) HTTP status code. The value is only valid if #rc is ::LCB_SUCCESS
+  #   (if #rc is not LCB_SUCCESS then this field may be 0 as the response may
+  #   have not been read/sent)
+  # :headers ::
+  #   (FFI::Pointer(**CharS)) List of key-value headers. This field itself may be `NULL`. The list
+  #   is terminated by a `NULL` pointer to indicate no more headers.
+  # :body ::
+  #   (FFI::Pointer(*Void)) If @ref LCB_CMDHTTP_F_STREAM is true, contains the current chunk
+  #   of response content. Otherwise, contains the entire response body.
+  # :nbody ::
+  #   (Integer) Length of buffer in #body
+  # :htreq ::
+  #   (HttpRequestT) @private
+  class RESPHTTP < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :htstatus, :short,
+           :headers, :pointer,
+           :body, :pointer,
+           :nbody, :ulong,
+           :htreq, HttpRequestT.by_ref
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respmcversion.rb

@@ -0,0 +1,38 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :server ::
+  #   (String)
+  # :mcversion ::
+  #   (String) < The version string
+  # :nversion ::
+  #   (Integer) < Length of the version string
+  class RESPMCVERSION < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :server, :string,
+           :mcversion, :string,
+           :nversion, :ulong
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respn1ql.rb

@@ -0,0 +1,41 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :row ::
+  #   (String) Current result row. If #rflags has the ::LCB_RESP_F_FINAL bit set, then
+  #   this field does not contain the actual row, but the remainder of the
+  #   data not included with the resultset; e.g. the JSON surrounding
+  #   the "results" field with any errors or metadata for the response.
+  # :nrow ::
+  #   (Integer) Length of the row
+  # :htresp ::
+  #   (RESPHTTP) Raw HTTP response, if applicable
+  class RESPN1QL < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :row, :pointer,
+           :nrow, :ulong,
+           :htresp, RESPHTTP.by_ref
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respobseqno.rb

@@ -0,0 +1,52 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :vbid ::
+  #   (Integer) < vBucket ID (for potential mapping)
+  # :server_index ::
+  #   (Integer) < Input server index
+  # :cur_uuid ::
+  #   (Integer) < UUID for this vBucket as known to the server
+  # :persisted_seqno ::
+  #   (Integer) < Highest persisted sequence
+  # :mem_seqno ::
+  #   (Integer) < Highest known sequence
+  # :old_uuid ::
+  #   (Integer) In the case where the command's uuid is not the most current, this
+  #   contains the last known UUID
+  # :old_seqno ::
+  #   (Integer) If #old_uuid is nonzero, contains the highest sequence number persisted
+  #   in the #old_uuid snapshot.
+  class RESPOBSEQNO < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :vbid, :ushort,
+           :server_index, :ushort,
+           :cur_uuid, :ulong_long,
+           :persisted_seqno, :ulong_long,
+           :mem_seqno, :ulong_long,
+           :old_uuid, :ulong_long,
+           :old_seqno, :ulong_long
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respobserve.rb

@@ -0,0 +1,41 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :status ::
+  #   (Integer) <Bit set of flags
+  # :ismaster ::
+  #   (Integer) < Set to true if this response came from the master node
+  # :ttp ::
+  #   (Integer) <Unused. For internal requests, contains the server index
+  # :ttr ::
+  #   (Integer) <Unused
+  class RESPOBSERVE < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :status, :uchar,
+           :ismaster, :uchar,
+           :ttp, :uint,
+           :ttr, :uint
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respserverbase.rb

@@ -0,0 +1,32 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :server ::
+  #   (String)
+  class RESPSERVERBASE < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :server, :string
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respstats.rb

@@ -0,0 +1,38 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :server ::
+  #   (String)
+  # :value ::
+  #   (String) < The value, if any, for the given statistic
+  # :nvalue ::
+  #   (Integer) < Length of value
+  class RESPSTATS < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :server, :string,
+           :value, :string,
+           :nvalue, :ulong
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/respstore.rb

@@ -0,0 +1,32 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cookie ::
+  #   (FFI::Pointer(*Void))
+  # :key ::
+  #   (FFI::Pointer(*Void))
+  # :nkey ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :rc ::
+  #   (ErrorT)
+  # :version ::
+  #   (Integer)
+  # :rflags ::
+  #   (Integer)
+  # :op ::
+  #   (StorageT) The type of operation which was performed
+  class RESPSTORE < FFI::Struct
+    layout :cookie, :pointer,
+           :key, :pointer,
+           :nkey, :ulong,
+           :cas, :ulong_long,
+           :rc, ErrorT,
+           :version, :ushort,
+           :rflags, :ushort,
+           :op, StorageT
+  end
+
+end