The class ClientComm represents one connection between one client entity (for example an object of class r_Database) and the server. More...

#include <clientcomm.hh>

Inheritance diagram for ClientComm:

Public Member Functions
virtual	~ClientComm ()=default
	destructor (closes the connection and releases resources)


virtual int	openDB (const char *database)=0
	Database methods.

virtual int	closeDB ()=0
	close current database

virtual int	createDB (const char *name)=0
	create a database

virtual int	destroyDB (const char *name)=0
	destroy a database


virtual int	openTA (unsigned short readOnly=0)=0
	Transaction methods.

virtual int	commitTA ()=0
	commit current transaction

virtual int	abortTA ()=0
	abort current transaction


virtual void	insertMDD (const char collName, r_GMarray mar)=0
	MDD methods.

virtual r_Ref_Any	getMDDByOId (const r_OId &oid)=0
	gets MDD object by oid


virtual void	insertColl (const char collName, const char typeName, const r_OId &oid)=0
	Collection methods.

virtual void	deleteCollByName (const char *collName)=0
	deletes an MDD collection by name

virtual void	deleteObjByOId (const r_OId &oid)=0
	deletes an object by oid (right now, objects are collection only)

virtual void	removeObjFromColl (const char *name, const r_OId &oid)=0
	removes an object from a collection

virtual r_Ref_Any	getCollByName (const char *name)=0
	gets collection by name

virtual r_Ref_Any	getCollByOId (const r_OId &oid)=0
	gets collection by oid

virtual r_Ref_Any	getCollOIdsByName (const char *name)=0
	gets collection references by name

virtual r_Ref_Any	getCollOIdsByOId (const r_OId &oid)=0
	gets collection references by oid


virtual void	executeQuery (const r_OQL_Query &query, r_Set< r_Ref_Any > &result)=0
	Query methods.

virtual void	executeQuery (const r_OQL_Query &query)=0
	Executes an update query of type r_OQL_Query.

virtual void	executeQuery (const r_OQL_Query &query, r_Set< r_Ref_Any > &result, int dummy)=0
	Executes an insert query of type r_OQL_Query, returning the OId of the inserted array.


virtual int	setTransferFormat (r_Data_Format format, const char *formatParams=NULL)=0
	Configuration methods.

virtual int	setStorageFormat (r_Data_Format format, const char *formatParams=NULL)=0
	set the preferred storage format

virtual void	setUserIdentification (const char userName, const char plainTextPassword)=0
	user identification for RasMGR

virtual void	setMaxRetry (unsigned int newMaxRetry)=0
	set maximum retry to get a server

virtual unsigned int	getMaxRetry ()=0
	get maximum retry to get a server

virtual void	setTimeoutInterval (int seconds)=0
	set communication timeout interval in seconds.

virtual int	getTimeoutInterval ()=0
	get communication timeout interval in seconds.

void	setDatabase (r_Database *database)
	sets the database that is using this client communicator

void	setTransaction (r_Transaction *transaction)
	sets the transaction that is using this client communicator

virtual void	updateTransaction ()
	resets to the global r_Transaction::actual_transaction if necessary

Protected Member Functions
	ClientComm ()=default
	constructor getting nothing

Protected Attributes
r_Database *	database
	reference to the database that created this client communicator

r_Transaction *	transaction
	reference to the transaction being used by this client communicator

enum	r_Type_Type { r_SetType_Type = 1 , r_MDDType_Type = 2 }

virtual r_OId	getNewOId (unsigned short objType)=0
	System methods.

virtual unsigned short	getObjectType (const r_OId &oid)=0
	get oid type

virtual char *	getTypeStructure (const char *typeName, r_Type_Type typeType)=0
	get type structure deallocate using delete []

Detailed Description

The class ClientComm represents one connection between one client entity (for example an object of class r_Database) and the server.

Member Enumeration Documentation

◆ r_Type_Type

enum ClientComm::r_Type_Type

Enumerator
r_SetType_Type
r_MDDType_Type

Constructor & Destructor Documentation

◆ ~ClientComm()

virtual ClientComm::~ClientComm ( )

virtualdefault

destructor (closes the connection and releases resources)

◆ ClientComm()

ClientComm::ClientComm ( )

protecteddefault

constructor getting nothing

Member Function Documentation

◆ abortTA()

virtual int ClientComm::abortTA ( )

pure virtual

abort current transaction

Implemented in RasnetClientComm.

◆ closeDB()

virtual int ClientComm::closeDB ( )

pure virtual

close current database

Implemented in RasnetClientComm.

◆ commitTA()

virtual int ClientComm::commitTA ( )

pure virtual

commit current transaction

Implemented in RasnetClientComm.

◆ createDB()

virtual int ClientComm::createDB ( const char * name )

pure virtual

create a database

Implemented in RasnetClientComm.

◆ deleteCollByName()

virtual void ClientComm::deleteCollByName ( const char * collName )

pure virtual

deletes an MDD collection by name

Implemented in RasnetClientComm.

◆ deleteObjByOId()

virtual void ClientComm::deleteObjByOId ( const r_OId & oid )

pure virtual

deletes an object by oid (right now, objects are collection only)

Implemented in RasnetClientComm.

◆ destroyDB()

virtual int ClientComm::destroyDB ( const char * name )

pure virtual

destroy a database

Implemented in RasnetClientComm.

◆ executeQuery() [1/3]

virtual void ClientComm::executeQuery ( const r_OQL_Query & query )

pure virtual

Executes an update query of type r_OQL_Query.

Implemented in RasnetClientComm.

◆ executeQuery() [2/3]

virtual void ClientComm::executeQuery	(	const r_OQL_Query &	query,
		r_Set< r_Ref_Any > &	result
	)

pure virtual

Query methods.

Executes a retrieval query of type r_OQL_Query and returns the result. Every MDD object of the MDD collection is fetched from the server and inserted in the result r_Set.

Implemented in RasnetClientComm.

◆ executeQuery() [3/3]

virtual void ClientComm::executeQuery	(	const r_OQL_Query &	query,
		r_Set< r_Ref_Any > &	result,
		int	dummy
	)

pure virtual

Executes an insert query of type r_OQL_Query, returning the OId of the inserted array.

The third parameter is only used to distinguish the method signature from the retrieval query one.

Implemented in RasnetClientComm.

◆ getCollByName()

virtual r_Ref_Any ClientComm::getCollByName ( const char * name )

pure virtual

gets collection by name

Implemented in RasnetClientComm.

◆ getCollByOId()

virtual r_Ref_Any ClientComm::getCollByOId ( const r_OId & oid )

pure virtual

gets collection by oid

Implemented in RasnetClientComm.

◆ getCollOIdsByName()

virtual r_Ref_Any ClientComm::getCollOIdsByName ( const char * name )

pure virtual

gets collection references by name

Implemented in RasnetClientComm.

◆ getCollOIdsByOId()

virtual r_Ref_Any ClientComm::getCollOIdsByOId ( const r_OId & oid )

pure virtual

gets collection references by oid

Implemented in RasnetClientComm.

◆ getMaxRetry()

virtual unsigned int ClientComm::getMaxRetry ( )

pure virtual

get maximum retry to get a server

Implemented in RasnetClientComm.

◆ getMDDByOId()

virtual r_Ref_Any ClientComm::getMDDByOId ( const r_OId & oid )

pure virtual

gets MDD object by oid

Implemented in RasnetClientComm.

◆ getNewOId()

virtual r_OId ClientComm::getNewOId ( unsigned short objType )

pure virtual

System methods.

get new oid

Implemented in RasnetClientComm.

◆ getObjectType()

virtual unsigned short ClientComm::getObjectType ( const r_OId & oid )

pure virtual

get oid type

Implemented in RasnetClientComm.

◆ getTimeoutInterval()

virtual int ClientComm::getTimeoutInterval ( )

pure virtual

get communication timeout interval in seconds.

Implemented in RasnetClientComm.

◆ getTypeStructure()

virtual char * ClientComm::getTypeStructure	(	const char *	typeName,
		r_Type_Type	typeType
	)

pure virtual

get type structure deallocate using delete []

Implemented in RasnetClientComm.

◆ insertColl()

virtual void ClientComm::insertColl	(	const char *	collName,
		const char *	typeName,
		const r_OId &	oid
	)

pure virtual

Collection methods.

creates an empty MDD collection on the server

Implemented in RasnetClientComm.

◆ insertMDD()

virtual void ClientComm::insertMDD	(	const char *	collName,
		r_GMarray *	mar
	)

pure virtual

MDD methods.

inserts a MDD object in an existing MDD collection on the server

Implemented in RasnetClientComm.

◆ openDB()

virtual int ClientComm::openDB ( const char * database )

pure virtual

Database methods.

open database

Implemented in RasnetClientComm.

◆ openTA()

virtual int ClientComm::openTA ( unsigned short readOnly = 0 )

pure virtual

Transaction methods.

begin transaction

Implemented in RasnetClientComm.

◆ removeObjFromColl()

virtual void ClientComm::removeObjFromColl	(	const char *	name,
		const r_OId &	oid
	)

pure virtual

removes an object from a collection

Implemented in RasnetClientComm.

◆ setDatabase()

void ClientComm::setDatabase ( r_Database * database )

sets the database that is using this client communicator

◆ setMaxRetry()

virtual void ClientComm::setMaxRetry ( unsigned int newMaxRetry )

pure virtual

set maximum retry to get a server

Implemented in RasnetClientComm.

◆ setStorageFormat()

virtual int ClientComm::setStorageFormat	(	r_Data_Format	format,
		const char *	formatParams = `NULL`
	)

pure virtual

set the preferred storage format

Implemented in RasnetClientComm.

◆ setTimeoutInterval()

virtual void ClientComm::setTimeoutInterval ( int seconds )

pure virtual

set communication timeout interval in seconds.

Implemented in RasnetClientComm.

◆ setTransaction()

void ClientComm::setTransaction ( r_Transaction * transaction )

sets the transaction that is using this client communicator

◆ setTransferFormat()

virtual int ClientComm::setTransferFormat	(	r_Data_Format	format,
		const char *	formatParams = `NULL`
	)

pure virtual

Configuration methods.

set the preferred transfer format

Implemented in RasnetClientComm.

◆ setUserIdentification()

virtual void ClientComm::setUserIdentification	(	const char *	userName,
		const char *	plainTextPassword
	)

pure virtual

user identification for RasMGR

Implemented in RasnetClientComm.

◆ updateTransaction()

virtual void ClientComm::updateTransaction ( )

virtual

resets to the global r_Transaction::actual_transaction if necessary

Member Data Documentation

◆ database

r_Database* ClientComm::database

protected

reference to the database that created this client communicator

◆ transaction

r_Transaction* ClientComm::transaction

protected

reference to the transaction being used by this client communicator

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

clientcomm.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ r_Type_Type

Constructor & Destructor Documentation

◆ ~ClientComm()

◆ ClientComm()

Member Function Documentation

◆ abortTA()

◆ closeDB()

◆ commitTA()

◆ createDB()

◆ deleteCollByName()

◆ deleteObjByOId()

◆ destroyDB()

◆ executeQuery() [1/3]

◆ executeQuery() [2/3]

◆ executeQuery() [3/3]

◆ getCollByName()

◆ getCollByOId()

◆ getCollOIdsByName()

◆ getCollOIdsByOId()

◆ getMaxRetry()

◆ getMDDByOId()

◆ getNewOId()

◆ getObjectType()

◆ getTimeoutInterval()

◆ getTypeStructure()

◆ insertColl()

◆ insertMDD()

◆ openDB()

◆ openTA()

◆ removeObjFromColl()

◆ setDatabase()

◆ setMaxRetry()

◆ setStorageFormat()

◆ setTimeoutInterval()

◆ setTransaction()

◆ setTransferFormat()

◆ setUserIdentification()

◆ updateTransaction()

Member Data Documentation

◆ database

◆ transaction