zeus::TAbstractStub Class Reference

#include <AbstractStub.h>

Inheritance diagram for zeus::TAbstractStub:

List of all members.

Public Member Functions
	TAbstractStub ()
virtual Retval MQUALIFIER	connect (const IString &rAddress, Uint uiPort)
virtual Retval MQUALIFIER	askForInterface (Uint uiInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
: Name of the method
Starts the delegation of a method call to the remote method call. : Method signature (something like: void classid::methodname )
virtual void MQUALIFIER	setClassName (const IString &rName)
virtual void MQUALIFIER	setCodeModuleName (const IString &rName)
virtual void MQUALIFIER	getClassName (IString &rName) const
virtual void MQUALIFIER	getCodeModuleName (IString &rName) const
virtual Retval MQUALIFIER	getConnectionParam (IString &rAddress, Uint &uiPort) const
Protected Member Functions
virtual	~TAbstractStub ()
Retval	sendMethod (TRemoteMethodCall &rMethod, IRemoteMethodCall *&rpMethodreturn) const
Retval	getMethodReturn (IRemoteMethodCall *&rpMethodreturn) const
void	disconnect ()
Protected Attributes
TSocket *	m_pSocket
	Socket class.
TString	m_strCodeModule
	Name of the codeModule.
TString	m_strClassName
	name of the class
TString	m_strAddress
	IP address.
Uint	m_uiPort
	TCP port.

---

Detailed Description

This class implements an abstract sub for connecting, sending method calls and receiving return values from the methods

---

Constructor & Destructor Documentation

TAbstractStub::TAbstractStub

(

)

Creates an abstract stub object

TAbstractStub::~TAbstractStub

(

)

[protected, virtual]

Destroys the stub

---

Member Function Documentation

void MQUALIFIER zeus::TAbstractStub::setClassName

(

const IString &

rName

)

[inline, virtual]

See also:

IRemoteObjectStub::setClassName

Implements zeus::IRemoteObjectStub.

void MQUALIFIER zeus::TAbstractStub::setCodeModuleName

(

const IString &

rName

)

[inline, virtual]

See also:

IRemoteObjectStub::setCodeModuleName

Implements zeus::IRemoteObjectStub.

Retval MQUALIFIER TAbstractStub::connect	(	const IString &	rAddress,
		Uint	uiPort
	)			[virtual]

See also:

IRemoteObjectStub::connect

Implements zeus::IRemoteObjectStub.

Reimplemented in zeus::TCommPipe_Stub.

void MQUALIFIER zeus::TAbstractStub::getClassName

(

IString &

rName

)

const [inline, virtual]

See also:

IRemoteObject::getClassName

Implements zeus::IRemoteObject.

void MQUALIFIER zeus::TAbstractStub::getCodeModuleName

(

IString &

rName

)

const [inline, virtual]

See also:

IRemoteObject::getCodeModuleName

Implements zeus::IRemoteObject.

Retval MQUALIFIER zeus::TAbstractStub::getConnectionParam	(	IString &	rAddress,
		Uint &	uiPort
	)			const [inline, virtual]

See also:

IRemoteObject::getConnectionParam

Implements zeus::IRemoteObject.

virtual Retval MQUALIFIER zeus::TAbstractStub::askForInterface	(	Uint	uiInterfaceID,
		IZUnknown *&	rpIface
	)			[virtual]

Reimplemented from zeus::TZObject.

Reimplemented in zeus::TCommPipe_Stub, zeus::TMessagePool_Stub, zeus::TMessageServerConnection_Stub, and zeus::TNamedContext_Stub.

virtual void MQUALIFIER zeus::TAbstractStub::addRef

(

)

const [virtual]

See also:

IZUnknown::addRef

Reimplemented from zeus::TZObject.

Reimplemented in zeus::TCommPipe_Stub, zeus::TMessagePool_Stub, zeus::TMessageServerConnection_Stub, and zeus::TNamedContext_Stub.

virtual void MQUALIFIER zeus::TAbstractStub::release

(

)

const [virtual]

See also:

IZUnknown::release

Reimplemented from zeus::TZObject.

Reimplemented in zeus::TCommPipe_Stub, zeus::TMessagePool_Stub, zeus::TMessageServerConnection_Stub, and zeus::TNamedContext_Stub.

Retval TAbstractStub::sendMethod	(	TRemoteMethodCall &	rMethod,
		IRemoteMethodCall *&	rMethodreturn
	)			const [protected]

This method sends a remote method call to a remote object and waits until the response will arrive. The response will be returned by the 2nd argument and must be released if the method returns RET_NOERROR

Parameters:

	rMethod	: Method object to send
	rMethodreturn	: Method object containing the return values. If no return value must be received, this parameter must be NULL.

Return values:

	RET_NOERROR	: Method has been returned
	RET_NETWORK_ERROR	: Error using the network layer
	RET_SERIALIZE_FAILED	: Could not serialize the object
	RET_REMOTECALL_ERROR	: CCTP Protocol returned error or unable to create the returned object.
	RET_REMOTEPROTOCOL_ERROR	: Transport protocol returns an error

Precondition:

The method parameter must be valid.

Retval TAbstractStub::getMethodReturn

(

IRemoteMethodCall *&

rpMethodreturn

)

const [protected]

this method trys to receive the return values of the method

Parameters:

rMethodreturn

: Return values of the remote method call. If this parameter is NULL, this method checks only the CCTP return value

Returns:

Error codes (see sendMethod())

Precondition:

The parameter methodreturn and the member m_pSocket must be valid

void TAbstractStub::disconnect

(

)

[protected]

Disconnects from the remote object

---

Member Data Documentation

TSocket* zeus::TAbstractStub::m_pSocket [protected]

Socket class.

TString zeus::TAbstractStub::m_strCodeModule [protected]

Name of the codeModule.

TString zeus::TAbstractStub::m_strClassName [protected]

name of the class

TString zeus::TAbstractStub::m_strAddress [protected]

IP address.

Uint zeus::TAbstractStub::m_uiPort [protected]

TCP port.

---

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

• AbstractStub.h
• AbstractStub.cpp