This class provides the interface to the APR persistency software. More...

#include <IPoolSvc.h>

Inheritance diagram for IPoolSvc:

Collaboration diagram for IPoolSvc:

Public Types
enum	PoolStream { kInputStream , kOutputStream }
	Stream to distinguish the POOL Stream instances. More...

Public Member Functions
	DeclareInterfaceID (IPoolSvc, 1, 0)
	Declare interface ID.
virtual Token *	registerForWrite (const Placement placement, const void obj, const RootType &classDesc)=0
virtual void	setObjPtr (void &obj, const Token token)=0
virtual unsigned int	getOutputContext (const std::string &label)=0
virtual unsigned int	getInputContext (const std::string &label, unsigned int maxFile=0)=0
virtual std::map< std::string, unsigned int >	getInputContextMap () const =0
virtual unsigned int	getInputContextMapSize () const =0
virtual void	setShareMode (bool shareCat)=0
virtual void	startCatalog ()=0
virtual void	commitCatalog ()=0
virtual void	lookupBestPfn (const std::string &token, std::string &pfn, std::string &type) const =0
virtual void	renamePfn (const std::string &pf, const std::string &newpf)=0
virtual pool::ICollection *	createCollection (const std::string &connection, const std::string &collectionName, const pool::DbType &collectionType, unsigned int contextId=IPoolSvc::kInputStream) const =0
virtual Token *	getToken (const std::string &connection, const std::string &collection, const unsigned long ientry) const =0
virtual StatusCode	connect (Io::IoFlag type, unsigned int contextId=IPoolSvc::kInputStream)=0
	Connect to a logical database unit; PersistencySvc is chosen according to transaction type (accessmode).
virtual StatusCode	commit (unsigned int contextId=IPoolSvc::kInputStream) const =0
	Commit data for a given stream and flush buffer.
virtual StatusCode	commitAndHold (unsigned int contextId=IPoolSvc::kInputStream) const =0
	Commit data for a given stream and hold buffer.
virtual StatusCode	disconnect (unsigned int contextId=IPoolSvc::kInputStream) const =0
	Disconnect PersistencySvc associated with a stream.
virtual StatusCode	disconnectDb (const std::string &connection, unsigned int contextId=IPoolSvc::kInputStream) const =0
	Disconnect single Database.
virtual StatusCode	getAttribute (const std::string &optName, std::string &data, long tech, unsigned int contextId=IPoolSvc::kInputStream) const =0
	Get POOL attributes - domain.
virtual StatusCode	getAttribute (const std::string &optName, std::string &data, long tech, const std::string &dbName, const std::string &contName="", unsigned int contextId=IPoolSvc::kInputStream) const =0
	Get POOL attributes - db/file, container/collection.
virtual StatusCode	setAttribute (const std::string &optName, const std::string &data, long tech, unsigned int contextId=IPoolSvc::kOutputStream) const =0
	Set POOL attributes - domain.
virtual StatusCode	setAttribute (const std::string &optName, const std::string &data, long tech, const std::string &dbName, const std::string &contName="", unsigned int contextId=IPoolSvc::kOutputStream) const =0
	Set POOL attributes - db/file, container/collection.

Detailed Description

This class provides the interface to the APR persistency software.

Definition at line 35 of file IPoolSvc.h.

Member Enumeration Documentation

◆ PoolStream

enum IPoolSvc::PoolStream

Stream to distinguish the POOL Stream instances.

Enumerator
kInputStream
kOutputStream

Definition at line 39 of file IPoolSvc.h.

39{ kInputStream, kOutputStream };

IPoolSvc::kOutputStream

@ kOutputStream

Definition IPoolSvc.h:39

IPoolSvc::kInputStream

@ kInputStream

Definition IPoolSvc.h:39

Member Function Documentation

◆ commit()

virtual StatusCode IPoolSvc::commit ( unsigned int contextId = IPoolSvc::kInputStream ) const

pure virtual

Commit data for a given stream and flush buffer.

Parameters

stream [IN] poolStream to be commited.

◆ commitAndHold()

virtual StatusCode IPoolSvc::commitAndHold ( unsigned int contextId = IPoolSvc::kInputStream ) const

pure virtual

Commit data for a given stream and hold buffer.

Parameters

stream [IN] poolStream to be commited.

◆ commitCatalog()

virtual void IPoolSvc::commitCatalog ( )

pure virtual

Returns: void

◆ connect()

virtual StatusCode IPoolSvc::connect	(	Io::IoFlag	type,
		unsigned int	contextId = IPoolSvc::kInputStream )

pure virtual

Connect to a logical database unit; PersistencySvc is chosen according to transaction type (accessmode).

◆ createCollection()

virtual pool::ICollection * IPoolSvc::createCollection	(	const std::string &	connection,
		const std::string &	collectionName,
		const pool::DbType &	collectionType,
		unsigned int	contextId = IPoolSvc::kInputStream ) const

pure virtual

Returns: a pointer to a Pool Collection.

Parameters

collectionType	[IN] string containing the collection type.
connection	[IN] string containing the connection.
collectionName	[IN] string containing the persistent name of the collection.
contextId	[IN] id for PoolSvc persistency service to use for input.

◆ DeclareInterfaceID()

IPoolSvc::DeclareInterfaceID	(	IPoolSvc	,
		1	,
		0	)

Declare interface ID.

◆ disconnect()

virtual StatusCode IPoolSvc::disconnect ( unsigned int contextId = IPoolSvc::kInputStream ) const

pure virtual

Disconnect PersistencySvc associated with a stream.

Parameters

stream [IN] poolStream to be disconnected.

◆ disconnectDb()

virtual StatusCode IPoolSvc::disconnectDb	(	const std::string &	connection,
		unsigned int	contextId = IPoolSvc::kInputStream ) const

pure virtual

Disconnect single Database.

Parameters

connection	[IN] connection string for Database to be disconnected.
contextId	[IN] context id of database to be disconnected.

◆ getAttribute() [1/2]

virtual StatusCode IPoolSvc::getAttribute	(	const std::string &	optName,
		std::string &	data,
		long	tech,
		const std::string &	dbName,
		const std::string &	contName = "",
		unsigned int	contextId = IPoolSvc::kInputStream ) const

pure virtual

Get POOL attributes - db/file, container/collection.

◆ getAttribute() [2/2]

virtual StatusCode IPoolSvc::getAttribute	(	const std::string &	optName,
		std::string &	data,
		long	tech,
		unsigned int	contextId = IPoolSvc::kInputStream ) const

pure virtual

Get POOL attributes - domain.

◆ getInputContext()

virtual unsigned int IPoolSvc::getInputContext	(	const std::string &	label,
		unsigned int	maxFile = 0 )

pure virtual

Returns: an Id for an input context (POOL persistency service) and create it if needed.

Parameters

label	[IN] string label to name new context and allow sharing (returns existing contextId)
maxFile	[IN] maximum number of open input files.

◆ getInputContextMap()

virtual std::map< std::string, unsigned int > IPoolSvc::getInputContextMap ( ) const

pure virtual

Returns: copy of the map of all labelled input contexts.

◆ getInputContextMapSize()

virtual unsigned int IPoolSvc::getInputContextMapSize ( ) const

pure virtual

Returns: size of the map of all labelled input contexts.

◆ getOutputContext()

virtual unsigned int IPoolSvc::getOutputContext ( const std::string & label )

pure virtual

Returns: an Id for an output context (POOL persistency service) and create it if needed.

Parameters

label [IN] string label to name new context and allow sharing (returns existing contextId)

◆ getToken()

virtual Token * IPoolSvc::getToken	(	const std::string &	connection,
		const std::string &	collection,
		const unsigned long	ientry ) const

pure virtual

Returns: a shared Token ptr for a container entry.

Parameters

connection	[IN] string containing the connection/file name.
collection	[IN] string containing the persistent name of the collection.
ientry	[IN] entry number for the token to be returned

◆ lookupBestPfn()

virtual void IPoolSvc::lookupBestPfn	(	const std::string &	token,
		std::string &	pfn,
		std::string &	type ) const

pure virtual

Returns: void

Parameters

token	[IN] filename/token string to be translated
pfn	[OUT] string PFN of database
type	[OUT] string filetype of database

◆ registerForWrite()

virtual Token * IPoolSvc::registerForWrite	(	const Placement *	placement,
		const void *	obj,
		const RootType &	classDesc )

pure virtual

Returns: a token to a Data Object written to Pool.

Parameters

placement	[IN] pointer to the placement hint.
obj	[IN] pointer to the Data Object to be written to Pool.
classDesc	[IN] pointer to the Seal class description for the Data Object.

◆ renamePfn()

virtual void IPoolSvc::renamePfn	(	const std::string &	pf,
		const std::string &	newpf )

pure virtual

Returns: void

Parameters

pf	[IN] filename to be renamed
newpf	[IN] new filename

◆ setAttribute() [1/2]

virtual StatusCode IPoolSvc::setAttribute	(	const std::string &	optName,
		const std::string &	data,
		long	tech,
		const std::string &	dbName,
		const std::string &	contName = "",
		unsigned int	contextId = IPoolSvc::kOutputStream ) const

pure virtual

Set POOL attributes - db/file, container/collection.

◆ setAttribute() [2/2]

virtual StatusCode IPoolSvc::setAttribute	(	const std::string &	optName,
		const std::string &	data,
		long	tech,
		unsigned int	contextId = IPoolSvc::kOutputStream ) const

pure virtual

Set POOL attributes - domain.

◆ setObjPtr()

virtual void IPoolSvc::setObjPtr	(	void *&	obj,
		const Token *	token )

pure virtual

Returns: void

Parameters

obj	[OUT] pointer to the Data Object.
token	[IN] token of the Data Object for which a Pool Ref is filled.

◆ setShareMode()

virtual void IPoolSvc::setShareMode ( bool shareCat )

pure virtual

Returns: void

Parameters

shareCat [IN] bool to share the file catalog.

◆ startCatalog()

virtual void IPoolSvc::startCatalog ( )

pure virtual

Returns: void

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

IPoolSvc.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ PoolStream

Member Function Documentation

◆ commit()

◆ commitAndHold()

◆ commitCatalog()

◆ connect()

◆ createCollection()

◆ DeclareInterfaceID()

◆ disconnect()

◆ disconnectDb()

◆ getAttribute() [1/2]

◆ getAttribute() [2/2]

◆ getInputContext()

◆ getInputContextMap()

◆ getInputContextMapSize()

◆ getOutputContext()

◆ getToken()

◆ lookupBestPfn()

◆ registerForWrite()

◆ renamePfn()

◆ setAttribute() [1/2]

◆ setAttribute() [2/2]

◆ setObjPtr()

◆ setShareMode()

◆ startCatalog()