glo::Manager::Receiver Class Reference

Is the remote station or the communicator which communicates with the Manager. In multi-user operation there can be several remote stations or communicators. More...

#include <GloManager.h>

Public Member Functions
	Receiver (const std::string &sSchemaName, CommunicaterThread *pCommunicatorThread, Communicator *pCommunicator)
	~Receiver ()
unsigned int	decrementRefCounter ()
Communicator *	getCommunicator () const
CommunicaterThread *	getCommunicatorThread () const
std::string	getSchemaName () const
unsigned int	incrementRefCounter ()

Private Member Functions
	Receiver ()
	Receiver (const Receiver &)
Manager::Receiver &	operator= (const Receiver &)

Private Attributes
Communicator *	m_pCommunicator
CommunicaterThread *	m_pCommunicatorThread
std::string	m_sSchemaName
unsigned int	m_uiRefCounter

Detailed Description

Is the remote station or the communicator which communicates with the Manager. In multi-user operation there can be several remote stations or communicators.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

Receiver() [1/3]

glo::Manager::Receiver::Receiver ( )

private

The standard constructor is not available.

Receiver() [2/3]

glo::Manager::Receiver::Receiver ( const Receiver & )

private

The copy constructor is not available.

Receiver() [3/3]

glo::Manager::Receiver::Receiver	(	const std::string &	sSchemaName,
		CommunicaterThread *	pCommunicatorThread,
		Communicator *	pCommunicator )

Constructor with parameter passing.

Parameters

[in]	sSchemaName	The name of the schema respectively database to which the communicator is logged on.
[in]	pCommunicatorThread	The communicator thread.
[in]	pCommunicator	The communicator.

Attention

The passed communicator thread becomes the responsibility of this object; therefore it must not be removed from memory by the calling instance.

~Receiver()

glo::Manager::Receiver::~Receiver

(

)

Destructor, the communicator thread is removed from memory.

Member Function Documentation

decrementRefCounter()

unsigned int glo::Manager::Receiver::decrementRefCounter

(

)

Returns the decremented reference counter.

Returns

The value of the reference counter (m_uiRefCounter).

getCommunicator()

Communicator * glo::Manager::Receiver::getCommunicator

(

)

const

Returns the communicator logged into the database.

Returns

The logged into communicator.

getCommunicatorThread()

CommunicaterThread * glo::Manager::Receiver::getCommunicatorThread

(

)

const

Returns the communicator thread.

Returns

The communicator thread.

Attention

The calling instance must not remove the supplied object from memory.

getSchemaName()

std::string glo::Manager::Receiver::getSchemaName

(

)

const

Returns the name of the schema respectively database to which the communicator is logged on.

Returns

The name of the schema respectively database.

incrementRefCounter()

unsigned int glo::Manager::Receiver::incrementRefCounter

(

)

Returns the incremented reference counter.

Returns

The value of the reference counter (m_uiRefCounter).

operator=()

Manager::Receiver & glo::Manager::Receiver::operator= ( const Receiver & )

private

The assignment operator is not available.

Member Data Documentation

m_pCommunicator

Communicator* glo::Manager::Receiver::m_pCommunicator

private

The communicator.

m_pCommunicatorThread

CommunicaterThread* glo::Manager::Receiver::m_pCommunicatorThread

private

The communicator thread.

m_sSchemaName

std::string glo::Manager::Receiver::m_sSchemaName

private

The name of the schema respectively database for which the communicator is registered.

m_uiRefCounter

unsigned int glo::Manager::Receiver::m_uiRefCounter

private

A reference counter to prevent multiple instantiation. Users of GlobalObjects can open the database multiple times (in threads for example). But only the reference counter is incremented. Only when the database is closed for the last time, the reference counter == 0 removes the communicator.

---

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

• GloManager.h