PMDK C++ bindings
1.7
This is the C++ bindings documentation for PMDK's libpmemobj.
libpmemobj++
utils.hpp
Go to the documentation of this file.
1
/*
2
* Copyright 2016-2018, Intel Corporation
3
*
4
* Redistribution and use in source and binary forms, with or without
5
* modification, are permitted provided that the following conditions
6
* are met:
7
*
8
* * Redistributions of source code must retain the above copyright
9
* notice, this list of conditions and the following disclaimer.
10
*
11
* * Redistributions in binary form must reproduce the above copyright
12
* notice, this list of conditions and the following disclaimer in
13
* the documentation and/or other materials provided with the
14
* distribution.
15
*
16
* * Neither the name of the copyright holder nor the names of its
17
* contributors may be used to endorse or promote products derived
18
* from this software without specific prior written permission.
19
*
20
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
*/
32
37
#ifndef LIBPMEMOBJ_CPP_UTILS_HPP
38
#define LIBPMEMOBJ_CPP_UTILS_HPP
39
40
#include <
libpmemobj++/detail/pexceptions.hpp
>
41
#include <
libpmemobj++/persistent_ptr.hpp
>
42
#include <libpmemobj/base.h>
43
44
namespace
pmem
45
{
46
47
namespace
obj
48
{
49
59
template
<
typename
T>
60
inline
pool_base
61
pool_by_vptr
(
const
T *that)
62
{
63
auto
pop = pmemobj_pool_by_ptr(that);
64
if
(!pop)
65
throw
pool_error
(
"Object not in an open pool."
);
66
67
return
pool_base
(pop);
68
}
69
79
template
<
typename
T>
80
inline
pool_base
81
pool_by_pptr
(
const
persistent_ptr<T>
ptr)
82
{
83
auto
pop = pmemobj_pool_by_oid(ptr.raw());
84
if
(!pop)
85
throw
pool_error
(
"Object not in an open pool."
);
86
87
return
pool_base
(pop);
88
}
89
90
}
/* namespace obj */
91
92
}
/* namespace pmem */
93
94
#endif
/* LIBPMEMOBJ_CPP_UTILS_HPP */
pmem::pool_error
Custom pool error class.
Definition:
pexceptions.hpp:53
pexceptions.hpp
Custom exceptions.
pmem::obj::pool_by_pptr
pool_base pool_by_pptr(const persistent_ptr< T > ptr)
Retrieve pool handle for the given persistent_ptr.
Definition:
utils.hpp:81
pmem::obj::persistent_ptr
Persistent pointer class.
Definition:
persistent_ptr.hpp:132
pmem::obj::pool_by_vptr
pool_base pool_by_vptr(const T *that)
Retrieve pool handle for the given pointer.
Definition:
utils.hpp:61
pmem::obj::pool_base
The non-template pool base class.
Definition:
pool.hpp:67
persistent_ptr.hpp
Persistent smart pointer.
Generated by
1.8.20