PMDK C++ bindings  1.13.0-git107.g7e59f08f
This is the C++ bindings documentation for PMDK's libpmemobj.
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12345]
 NpmemPersistent memory namespace
 NdetailImplementation details
 Cconcurrent_skip_listPersistent memory aware implementation of the concurrent skip list
 Ccontiguous_iteratorBase class for iterators which satisfies RandomAccessIterator and operate on contiguous memory
 Crange_snapshotting_iteratorNon-const iterator which adds elements to a transaction in a bulk
 Cbasic_contiguous_iteratorDefault non-const iterator which adds element to a transaction on every access
 CebrEpoch-based reclamation (EBR)
 Cid_managerThis structure is used for assigning unique thread ids so that those ids will be reused in case of thread exit
 Cthread_id_typeRAII-style structure for holding thread id
 Cenumerable_thread_specificClass for storing thread local data
 Cis_output_iteratorType trait to determine if a given parameter type satisfies requirements of OutputIterator
 Cis_input_iteratorType trait to determine if a given parameter type satisfies requirements of InputIterator
 Cis_forward_iteratorType trait to determine if a given parameter type satisfies requirements of ForwardIterator
 Cis_bidirectional_iteratorType trait to determine if a given parameter type satisfies requirements of BidirectionalIterator
 Cis_random_access_iteratorType trait to determine if a given parameter type satisfies requirements of RandomAccessIterator
 Cself_relative_ptr_base_implSelf_relative_ptr base template class
 Cself_relative_accessorStatic class accessor to self_relative_ptr_base
 Ctemp_valueTemplate class for caching objects based on constructor's variadic template arguments and LIBPMEMOBJ_CPP_MAX_STACK_ALLOC_SIZE
 Cvolatile_stateGlobal key value store which allows persistent objects to use volatile memory
 Ccan_do_snapshot< std::atomic< obj::experimental::self_relative_ptr< T > > >Pmem::detail::can_do_snapshot atomic specialization for self_relative_ptr
 Ccan_do_snapshotA structure that checks if it is possible to snapshot the specified memory
 Ctransaction_baseCommon functionality for basic_transaction and flat_transaction
 NobjMain libpmemobj namespace
 NexperimentalExperimental implementations
 Catomic_persistent_aware_ptrAtomic specialization of a persistent ptr (self_relative_ptr) that manages its persistence by itself
 Cconcurrent_mapPersistent memory aware implementation of Intel TBB concurrent_map with API partially compatible to std::map
 Cbasic_dram_inline_stringPmem/DRAM variation of pmem::obj::string, where data is kept right next to the inline_string structure
 Cbasic_inline_stringPmem-only variation of pmem::obj::string, where data is kept right next to the inline_string structure
 Ctotal_sizeofA helper trait which calculates required memory capacity (in bytes) for a type
 Ctotal_sizeof< basic_inline_string< CharT, Traits > >A helper trait which calculates required memory capacity (in bytes) for a type
 Ctotal_sizeof< basic_dram_inline_string< CharT, Traits > >A helper trait which calculates required memory capacity (in bytes) for a type
 Cmpsc_queuePersistent memory aware implementation of multi producer single consumer queue
 Cbatch_typeType representing the range of the mpsc_queue elements
 Cpmem_log_typeType representing persistent data, which may be managed by mpsc_queue
 CworkerMpsc_queue producer worker class
 Cradix_treePersistent associative, ordered container with API similar and partially compatible with the API of std::map
 CleafThis is the structure which 'holds' key/value pair
 CnodeThis is internal node
 Cself_relative_ptrPersistent self-relative pointer class
 CvVolatile residing on pmem class
 Nsegment_vector_internalInternal implementation of pmem's segment vector
 Csegment_iteratorIterator for segment_vector
 Callocation_flagType of flag which can be passed to make_persistent
 Callocation_flag_atomicType of flag which can be passed to make_persistent_atomic
 Cobject_traitsEncapsulates object specific allocator functionality
 CrebindRebind to a different type
 Cobject_traits< void >Object traits specialization for the void type
 CrebindRebind to a different type
 Cstandard_alloc_policyThe allocation policy template for a given type
 CrebindRebind to a different type
 Cstandard_alloc_policy< void >Void specialization of the standard allocation policy
 CrebindRebind to a different type
 Callocator(EXPERIMENTAL) Encapsulates the information about the persistent memory allocation model using PMDK's libpmemobj
 CrebindRebind to a different type
 Ccondition_variablePersistent memory resident condition variable
 CarrayPersistent container with std::array compatible interface
 Cbasic_stringPersistent string container with std::basic_string compatible interface
 Cconcurrent_hash_mapPersistent memory aware implementation of Intel TBB concurrent_hash_map
 CaccessorAllows write access to elements and combines data access, locking, and garbage collection
 Cbucket_accessorBucket accessor is to find, rehash, acquire a lock, and access a bucket
 Cconst_accessorCombines data access, locking, and garbage collection
 Cmutex_vectorVector of locks to be unlocked at the destruction time
 Cserial_bucket_accessorSerial bucket accessor used to access bucket in a serial operations
 Csegment_vectorPersistent version of segment vector with std::vector compatible interface
 CvectorPersistent container with std::vector compatible interface
 CdefragDefrag class
 Cpersistent_ptrPersistent pointer class
 CmutexPersistent memory resident mutex implementation
 CpResides on pmem class
 CpoolPMEMobj pool class
 Cpersistent_ptr< void >Persistent_ptr void specialization
 Cpersistent_ptr< const void >Persistent_ptr const void specialization
 Cpersistent_ptr_basePersistent_ptr base (non-template) class
 Cpool_baseThe non-template pool base class
 Cshared_mutexPersistent memory resident shared_mutex implementation
 CsliceProvides interface to access sequence of objects
 Cbasic_string_viewOur partial std::string_view implementation
 Ctimed_mutexPersistent memory resident timed_mutex implementation
 Cbasic_transactionC++ transaction handler class
 Cflat_transactionC++ flat transaction handler class
 Cpool_errorCustom pool error class
 Cpool_invalid_argumentCustom pool error class
 Ctransaction_errorCustom transaction error class
 Clock_errorCustom lock error class
 Ctransaction_alloc_errorCustom transaction error class
 Ctransaction_out_of_memoryCustom out of memory error class
 Ctransaction_free_errorCustom transaction error class
 Ctransaction_scope_errorCustom transaction error class
 Cmanual_tx_abortCustom transaction error class
 Clayout_errorCustom layout error class
 Cctl_errorCustom ctl error class
 Cdefrag_errorCustom defrag error class
 NstdSTL namespace
 Chash< pmem::obj::p< T > >Specialization of std::hash for p<T>
 Catomic< pmem::obj::experimental::self_relative_ptr< T > >Atomic specialization for self_relative_ptr
 Cnumeric_limits< pmem::obj::p< T > >Specialization of std::numeric_limits for p<T>
 Cless< pmem::obj::p< T > >Specialization of std::less for p<T>