#include <rasnetclientcomm.hh>

Inheritance diagram for RasnetClientComm:

Public Member Functions
	RasnetClientComm (const std::string &rasmgrHost, int rasmgrPort=DEFAULT_PORT)

	~RasnetClientComm () noexcept override

int	connectClient (const std::string &userName, const std::string &passwordHash)

int	disconnectClient ()

int	openDB (const char *database) override
	Database methods. More...

int	closeDB () override
	close current database More...

int	createDB (const char *name) override
	create a database More...

int	destroyDB (const char *name) override
	destroy a database More...

int	openTA (unsigned short readOnly) override
	Transaction methods. More...

int	commitTA () override
	commit current transaction More...

int	abortTA () override
	abort current transaction More...

void	insertMDD (const char collName, r_GMarray mar) override
	MDD methods. More...

r_Ref_Any	getMDDByOId (const r_OId &oid) override
	gets MDD object by oid More...

void	insertColl (const char collName, const char typeName, const r_OId &oid) override
	Collection methods. More...

void	deleteCollByName (const char *collName) override
	deletes an MDD collection by name More...

void	deleteObjByOId (const r_OId &oid) override
	deletes an object by oid (right now, objects are collection only) More...

void	removeObjFromColl (const char *name, const r_OId &oid) override
	removes an object from a collection More...

r_Ref_Any	getCollByName (const char *name) override
	gets collection by name More...

r_Ref_Any	getCollByOId (const r_OId &oid) override
	gets collection by oid More...

r_Ref_Any	getCollOIdsByName (const char *name) override
	gets collection references by name More...

r_Ref_Any	getCollOIdsByOId (const r_OId &oid) override
	gets collection references by oid More...

void	executeQuery (const r_OQL_Query &query, r_Set< r_Ref_Any > &result) override
	Query methods. More...

void	executeQuery (const r_OQL_Query &query) override
	Executes an update query of type r_OQL_Query. More...

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

r_OId	getNewOId (unsigned short objType) override
	System methods. More...

unsigned short	getObjectType (const r_OId &oid) override
	get oid type More...

char *	getTypeStructure (const char *typeName, r_Type_Type typeType) override
	get type structure deallocate using delete [] More...

int	setTransferFormat (r_Data_Format format, const char *formatParams=nullptr) override
	Configuration methods. More...

int	setStorageFormat (r_Data_Format format, const char *formatParams=nullptr) override
	set the preferred storage format More...

void	setUserIdentification (const char userName, const char plainTextPassword) override
	user identification for RasMGR More...

void	setMaxRetry (unsigned int newMaxRetry) override
	set maximum retry to get a server More...

unsigned int	getMaxRetry () override
	get maximum retry to get a server More...

void	setTimeoutInterval (int seconds) override
	set communication timeout interval in seconds. More...

int	getTimeoutInterval () override
	get communication timeout interval in seconds. More...

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

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

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

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

Additional Inherited Members
Public Types inherited from ClientComm
enum	r_Type_Type { r_SetType_Type = 1, r_MDDType_Type = 2 }

Protected Member Functions inherited from ClientComm
	ClientComm ()=default
	constructor getting nothing More...

Protected Attributes inherited from ClientComm
r_Database *	database
	reference to the database that created this client communicator More...

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

Constructor & Destructor Documentation

◆ RasnetClientComm()

RasnetClientComm::RasnetClientComm	(	const std::string &	rasmgrHost,
		int	rasmgrPort = `DEFAULT_PORT`
	)

explicit

◆ ~RasnetClientComm()

RasnetClientComm::~RasnetClientComm ( )

overridenoexcept

Member Function Documentation

◆ abortTA()

int RasnetClientComm::abortTA ( )

overridevirtual

abort current transaction

Implements ClientComm.

◆ closeDB()

int RasnetClientComm::closeDB ( )

overridevirtual

close current database

Implements ClientComm.

◆ commitTA()

int RasnetClientComm::commitTA ( )

overridevirtual

commit current transaction

Implements ClientComm.

◆ connectClient()

int RasnetClientComm::connectClient	(	const std::string &	userName,
		const std::string &	passwordHash
	)

◆ createDB()

int RasnetClientComm::createDB ( const char * name )

overridevirtual

create a database

Implements ClientComm.

◆ deleteCollByName()

void RasnetClientComm::deleteCollByName ( const char * collName )

overridevirtual

deletes an MDD collection by name

Implements ClientComm.

◆ deleteObjByOId()

void RasnetClientComm::deleteObjByOId ( const r_OId & oid )

overridevirtual

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

Implements ClientComm.

◆ destroyDB()

int RasnetClientComm::destroyDB ( const char * name )

overridevirtual

destroy a database

Implements ClientComm.

◆ disconnectClient()

int RasnetClientComm::disconnectClient ( )

◆ executeQuery() [1/3]

void RasnetClientComm::executeQuery ( const r_OQL_Query & query )

overridevirtual

Executes an update query of type r_OQL_Query.

Implements ClientComm.

◆ executeQuery() [2/3]

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

overridevirtual

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.

Implements ClientComm.

◆ executeQuery() [3/3]

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

overridevirtual

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.

Implements ClientComm.

◆ getCollByName()

r_Ref_Any RasnetClientComm::getCollByName ( const char * name )

overridevirtual

gets collection by name

Implements ClientComm.

◆ getCollByOId()

r_Ref_Any RasnetClientComm::getCollByOId ( const r_OId & oid )

overridevirtual

gets collection by oid

Implements ClientComm.

◆ getCollOIdsByName()

r_Ref_Any RasnetClientComm::getCollOIdsByName ( const char * name )

overridevirtual

gets collection references by name

Implements ClientComm.

◆ getCollOIdsByOId()

r_Ref_Any RasnetClientComm::getCollOIdsByOId ( const r_OId & oid )

overridevirtual

gets collection references by oid

Implements ClientComm.

◆ getMaxRetry()

unsigned int RasnetClientComm::getMaxRetry ( )

overridevirtual

get maximum retry to get a server

Implements ClientComm.

◆ getMDDByOId()

r_Ref_Any RasnetClientComm::getMDDByOId ( const r_OId & oid )

overridevirtual

gets MDD object by oid

Implements ClientComm.

◆ getNewOId()

r_OId RasnetClientComm::getNewOId ( unsigned short objType )

overridevirtual

System methods.

get new oid

Implements ClientComm.

◆ getObjectType()

unsigned short RasnetClientComm::getObjectType ( const r_OId & oid )

overridevirtual

get oid type

Implements ClientComm.

◆ getTimeoutInterval()

int RasnetClientComm::getTimeoutInterval ( )

overridevirtual

get communication timeout interval in seconds.

Implements ClientComm.

◆ getTypeStructure()

char* RasnetClientComm::getTypeStructure	(	const char *	typeName,
		r_Type_Type	typeType
	)

overridevirtual

get type structure deallocate using delete []

Implements ClientComm.

◆ insertColl()

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

overridevirtual

Collection methods.

creates an empty MDD collection on the server

Implements ClientComm.

◆ insertMDD()

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

overridevirtual

MDD methods.

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

Implements ClientComm.

◆ openDB()

int RasnetClientComm::openDB ( const char * database )

overridevirtual

Database methods.

open database

Implements ClientComm.

◆ openTA()

int RasnetClientComm::openTA ( unsigned short readOnly )

overridevirtual

Transaction methods.

begin transaction

Implements ClientComm.

◆ removeObjFromColl()

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

overridevirtual

removes an object from a collection

Implements ClientComm.

◆ setMaxRetry()

void RasnetClientComm::setMaxRetry ( unsigned int newMaxRetry )

overridevirtual

set maximum retry to get a server

Implements ClientComm.

◆ setStorageFormat()

int RasnetClientComm::setStorageFormat	(	r_Data_Format	format,
		const char *	formatParams = `nullptr`
	)

overridevirtual

set the preferred storage format

Implements ClientComm.

◆ setTimeoutInterval()

void RasnetClientComm::setTimeoutInterval ( int seconds )

overridevirtual

set communication timeout interval in seconds.

Implements ClientComm.

◆ setTransferFormat()

int RasnetClientComm::setTransferFormat	(	r_Data_Format	format,
		const char *	formatParams = `nullptr`
	)

overridevirtual

Configuration methods.

set the preferred transfer format

Implements ClientComm.

◆ setUserIdentification()

void RasnetClientComm::setUserIdentification	(	const char *	userName,
		const char *	plainTextPassword
	)

overridevirtual

user identification for RasMGR

Implements ClientComm.

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

rasnetclientcomm.hh

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ RasnetClientComm()

◆ ~RasnetClientComm()

Member Function Documentation

◆ abortTA()

◆ closeDB()

◆ commitTA()

◆ connectClient()

◆ createDB()

◆ deleteCollByName()

◆ deleteObjByOId()

◆ destroyDB()

◆ disconnectClient()

◆ executeQuery() [1/3]

◆ executeQuery() [2/3]

◆ executeQuery() [3/3]

◆ getCollByName()

◆ getCollByOId()

◆ getCollOIdsByName()

◆ getCollOIdsByOId()

◆ getMaxRetry()

◆ getMDDByOId()

◆ getNewOId()

◆ getObjectType()

◆ getTimeoutInterval()

◆ getTypeStructure()

◆ insertColl()

◆ insertMDD()

◆ openDB()

◆ openTA()

◆ removeObjFromColl()

◆ setMaxRetry()

◆ setStorageFormat()

◆ setTimeoutInterval()

◆ setTransferFormat()

◆ setUserIdentification()