PMEMKV  1.3.1-git1.g6468f74
This is the C++ documentation for PMEMKV.
Classes | Namespaces | Typedefs | Enumerations | Functions
libpmemkv.hpp File Reference

Main C++ pmemkv public header. More...

#include <functional>
#include <iostream>
#include <libpmemobj++/string_view.hpp>
#include <memory>
#include <stdexcept>
#include <string>
#include <utility>
#include "libpmemkv.h"
#include <libpmemobj/pool_base.h>

Go to the source code of this file.

Classes

class  pmem::kv::config
 Holds configuration parameters for engines. More...
 
class  pmem::kv::db
 Main pmemkv class, it provides functions to operate on data in database. More...
 
struct  pmem::kv::internal::unique_ptr_wrapper_base
 
struct  pmem::kv::internal::unique_ptr_wrapper< T, D >
 
class  pmem::kv::internal::comparator_base
 
struct  pmem::kv::internal::comparator_wrapper< Comparator >
 
struct  pmem::kv::internal::comparator_config_entry
 

Namespaces

 pmem
 Persistent memory namespace.
 
 pmem::kv
 Main pmemkv namespace.
 
 pmem::kv::internal
 internal pmemkv classes for C++ API
 

Typedefs

using pmem::kv::string_view = obj::string_view
 
typedef int pmem::kv::get_kv_function(string_view key, string_view value)
 The C++ idiomatic function type to use for callback using key-value pair. More...
 
typedef void pmem::kv::get_v_function(string_view value)
 The C++ idiomatic function type to use for callback using only the value. More...
 
typedef int pmem::kv::comparator_function(string_view key1, string_view key2)
 
using pmem::kv::get_kv_callback = pmemkv_get_kv_callback
 Key-value pair callback, C-style. More...
 
using pmem::kv::get_v_callback = pmemkv_get_v_callback
 Value-only callback, C-style. More...
 

Enumerations

enum  pmem::kv::status {
  pmem::kv::status::OK = PMEMKV_STATUS_OK, pmem::kv::status::UNKNOWN_ERROR = PMEMKV_STATUS_UNKNOWN_ERROR, pmem::kv::status::NOT_FOUND = PMEMKV_STATUS_NOT_FOUND, pmem::kv::status::NOT_SUPPORTED = PMEMKV_STATUS_NOT_SUPPORTED,
  pmem::kv::status::INVALID_ARGUMENT = PMEMKV_STATUS_INVALID_ARGUMENT, pmem::kv::status::CONFIG_PARSING_ERROR, pmem::kv::status::CONFIG_TYPE_ERROR, pmem::kv::status::STOPPED_BY_CB = PMEMKV_STATUS_STOPPED_BY_CB,
  pmem::kv::status::OUT_OF_MEMORY, pmem::kv::status::WRONG_ENGINE_NAME, pmem::kv::status::TRANSACTION_SCOPE_ERROR, pmem::kv::status::DEFRAG_ERROR = PMEMKV_STATUS_DEFRAG_ERROR,
  pmem::kv::status::COMPARATOR_MISMATCH
}
 Status returned by pmemkv functions. More...
 

Functions

std::ostream & pmem::kv::operator<< (std::ostream &os, const status &s)
 

Detailed Description

Main C++ pmemkv public header.

It contains all pmemkv public types, enums, classes with their functions and members.