A RDaosContainer provides read/write access to objects in a given container.

Definition at line 146 of file RDaos.hxx.

Classes
struct	RWOperation
	Describes a read/write operation on multiple objects; see the `ReadV`/`WriteV` functions. More...

Public Types
using	AttributeKey_t = RDaosObject::AttributeKey_t

using	DistributionKey_t = RDaosObject::DistributionKey_t

using	ObjClassId_t = RDaosObject::ObjClassId

Public Member Functions
	RDaosContainer (std::shared_ptr< RDaosPool > pool, std::string_view containerId, bool create=false)

	~RDaosContainer ()

std::string	GetContainerUuid ()

ObjClassId_t	GetDefaultObjectClass () const

int	ReadSingleAkey (void *buffer, std::size_t length, daos_obj_id_t oid, DistributionKey_t dkey, AttributeKey_t akey)

int	ReadSingleAkey (void *buffer, std::size_t length, daos_obj_id_t oid, DistributionKey_t dkey, AttributeKey_t akey, ObjClassId_t cid)
	Read data from a single object attribute key to the given buffer. More...

int	ReadV (std::vector< RWOperation > &vec)

int	ReadV (std::vector< RWOperation > &vec, ObjClassId_t cid)
	Perform a vector read operation on (possibly) multiple objects. More...

void	SetDefaultObjectClass (const ObjClassId_t cid)

int	WriteSingleAkey (const void *buffer, std::size_t length, daos_obj_id_t oid, DistributionKey_t dkey, AttributeKey_t akey)

int	WriteSingleAkey (const void *buffer, std::size_t length, daos_obj_id_t oid, DistributionKey_t dkey, AttributeKey_t akey, ObjClassId_t cid)
	Write the given buffer to a single object attribute key. More...

int	WriteV (std::vector< RWOperation > &vec)

int	WriteV (std::vector< RWOperation > &vec, ObjClassId_t cid)
	Perform a vector write operation on (possibly) multiple objects. More...

Private Member Functions
template<typename Fn >
int	VectorReadWrite (std::vector< RWOperation > &vec, ObjClassId_t cid, Fn fn)
	Perform a vector read/write operation on different objects. More...

Private Attributes
daos_handle_t	fContainerHandle {}

std::string	fContainerLabel {}

uuid_t	fContainerUuid {}

ObjClassId_t	fDefaultObjectClass {OC_SX}

std::shared_ptr< RDaosPool >	fPool

Friends
class	RDaosObject

#include <ROOT/RDaos.hxx>

Member Typedef Documentation

◆ AttributeKey_t

using ROOT::Experimental::Detail::RDaosContainer::AttributeKey_t = RDaosObject::AttributeKey_t

Definition at line 150 of file RDaos.hxx.

◆ DistributionKey_t

using ROOT::Experimental::Detail::RDaosContainer::DistributionKey_t = RDaosObject::DistributionKey_t

Definition at line 149 of file RDaos.hxx.

◆ ObjClassId_t

using ROOT::Experimental::Detail::RDaosContainer::ObjClassId_t = RDaosObject::ObjClassId

Definition at line 151 of file RDaos.hxx.

Constructor & Destructor Documentation

◆ RDaosContainer()

ROOT::Experimental::Detail::RDaosContainer::RDaosContainer	(	std::shared_ptr< RDaosPool >	pool,
		std::string_view	containerId,
		bool	create = `false`
	)

Definition at line 167 of file RDaos.cxx.

◆ ~RDaosContainer()

ROOT::Experimental::Detail::RDaosContainer::~RDaosContainer ( )

Definition at line 191 of file RDaos.cxx.

Member Function Documentation

◆ GetContainerUuid()

std::string ROOT::Experimental::Detail::RDaosContainer::GetContainerUuid ( )

Definition at line 195 of file RDaos.cxx.

◆ GetDefaultObjectClass()

ObjClassId_t ROOT::Experimental::Detail::RDaosContainer::GetDefaultObjectClass ( ) const

inline

Definition at line 218 of file RDaos.hxx.

◆ ReadSingleAkey() [1/2]

int ROOT::Experimental::Detail::RDaosContainer::ReadSingleAkey	(	void *	buffer,
		std::size_t	length,
		daos_obj_id_t	oid,
		DistributionKey_t	dkey,
		AttributeKey_t	akey
	)

inline

Definition at line 233 of file RDaos.hxx.

◆ ReadSingleAkey() [2/2]

int ROOT::Experimental::Detail::RDaosContainer::ReadSingleAkey	(	void *	buffer,
		std::size_t	length,
		daos_obj_id_t	oid,
		DistributionKey_t	dkey,
		AttributeKey_t	akey,
		ObjClassId_t	cid
	)

Read data from a single object attribute key to the given buffer.

Parameters

buffer	The address of a buffer that has capacity for at least `length` bytes.
length	Length of the buffer.
oid	A 128-bit DAOS object identifier.
dkey	The distribution key used for this operation.
akey	The attribute key used for this operation.
cid	An object class ID.

Returns: 0 if the operation succeeded; a negative DAOS error number otherwise.

Definition at line 202 of file RDaos.cxx.

◆ ReadV() [1/2]

int ROOT::Experimental::Detail::RDaosContainer::ReadV ( std::vector< RWOperation > & vec )

inline

Definition at line 261 of file RDaos.hxx.

◆ ReadV() [2/2]

int ROOT::Experimental::Detail::RDaosContainer::ReadV	(	std::vector< RWOperation > &	vec,
		ObjClassId_t	cid
	)

inline

Perform a vector read operation on (possibly) multiple objects.

Parameters

vec	A `std::vector<RWOperation>` that describes read operations to perform.
cid	An object class ID.

Returns: Number of operations that could not complete.

Definition at line 259 of file RDaos.hxx.

◆ SetDefaultObjectClass()

void ROOT::Experimental::Detail::RDaosContainer::SetDefaultObjectClass ( const ObjClassId_t cid )

inline

Definition at line 219 of file RDaos.hxx.

◆ VectorReadWrite()

template<typename Fn >

int ROOT::Experimental::Detail::RDaosContainer::VectorReadWrite	(	std::vector< RWOperation > &	vec,
		ObjClassId_t	cid,
		Fn	fn
	)

inlineprivate

Perform a vector read/write operation on different objects.

Parameters

vec	A `std::vector<RWOperation>` that describes read/write operations to perform.
cid	The `daos_oclass_id_t` used to qualify OIDs.
fn	Either `std::mem_fn<&RDaosObject::Fetch>` (read) or `std::mem_fn<&RDaosObject::Update>` (write).

Returns: DAOS error code (< 0) in case of failure, 0 on success.

Definition at line 181 of file RDaos.hxx.

◆ WriteSingleAkey() [1/2]

int ROOT::Experimental::Detail::RDaosContainer::WriteSingleAkey	(	const void *	buffer,
		std::size_t	length,
		daos_obj_id_t	oid,
		DistributionKey_t	dkey,
		AttributeKey_t	akey
	)

inline

Definition at line 249 of file RDaos.hxx.

◆ WriteSingleAkey() [2/2]

int ROOT::Experimental::Detail::RDaosContainer::WriteSingleAkey	(	const void *	buffer,
		std::size_t	length,
		daos_obj_id_t	oid,
		DistributionKey_t	dkey,
		AttributeKey_t	akey,
		ObjClassId_t	cid
	)

Write the given buffer to a single object attribute key.

Parameters

buffer	The address of the source buffer.
length	Length of the buffer.
oid	A 128-bit DAOS object identifier.
dkey	The distribution key used for this operation.
akey	The attribute key used for this operation.
cid	An object class ID.

Returns: 0 if the operation succeeded; a negative DAOS error number otherwise.

Definition at line 212 of file RDaos.cxx.

◆ WriteV() [1/2]

int ROOT::Experimental::Detail::RDaosContainer::WriteV ( std::vector< RWOperation > & vec )

inline

Definition at line 271 of file RDaos.hxx.

◆ WriteV() [2/2]

int ROOT::Experimental::Detail::RDaosContainer::WriteV	(	std::vector< RWOperation > &	vec,
		ObjClassId_t	cid
	)

inline

Perform a vector write operation on (possibly) multiple objects.

Parameters

vec	A `std::vector<RWOperation>` that describes write operations to perform.
cid	An object class ID.

Returns: Number of operations that could not complete.

Definition at line 269 of file RDaos.hxx.

Friends And Related Function Documentation

◆ RDaosObject

friend class RDaosObject

friend

Definition at line 147 of file RDaos.hxx.

Member Data Documentation

◆ fContainerHandle

daos_handle_t ROOT::Experimental::Detail::RDaosContainer::fContainerHandle {}

private

Definition at line 167 of file RDaos.hxx.

◆ fContainerLabel

std::string ROOT::Experimental::Detail::RDaosContainer::fContainerLabel {}

private

Definition at line 169 of file RDaos.hxx.

◆ fContainerUuid

uuid_t ROOT::Experimental::Detail::RDaosContainer::fContainerUuid {}

private

Definition at line 168 of file RDaos.hxx.

◆ fDefaultObjectClass

ObjClassId_t ROOT::Experimental::Detail::RDaosContainer::fDefaultObjectClass {OC_SX}

private

Definition at line 171 of file RDaos.hxx.

◆ fPool

std::shared_ptr<RDaosPool> ROOT::Experimental::Detail::RDaosContainer::fPool

private

Definition at line 170 of file RDaos.hxx.

The documentation for this class was generated from the following files:

tree/ntuple/v7/inc/ROOT/RDaos.hxx
tree/ntuple/v7/src/RDaos.cxx

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Member Typedef Documentation

◆ AttributeKey_t

◆ DistributionKey_t

◆ ObjClassId_t

Constructor & Destructor Documentation

◆ RDaosContainer()

◆ ~RDaosContainer()

Member Function Documentation

◆ GetContainerUuid()

◆ GetDefaultObjectClass()

◆ ReadSingleAkey() [1/2]

◆ ReadSingleAkey() [2/2]

◆ ReadV() [1/2]

◆ ReadV() [2/2]

◆ SetDefaultObjectClass()

◆ VectorReadWrite()

◆ WriteSingleAkey() [1/2]

◆ WriteSingleAkey() [2/2]

◆ WriteV() [1/2]

◆ WriteV() [2/2]

Friends And Related Function Documentation

◆ RDaosObject

Member Data Documentation

◆ fContainerHandle

◆ fContainerLabel

◆ fContainerUuid

◆ fDefaultObjectClass

◆ fPool