RTT::corba::CSendHandle Interface Reference

A handler object that allows us to collect the results of a send. More...

import"rtt/transports/corba/OperationInterface.idl";

Public Member Functions
CSendStatus	collect (out CAnyArguments args) raises (CCallError)
CSendStatus	collectIfDone (out CAnyArguments args) raises (CCallError)
CSendStatus	checkStatus ()
	Just checks what the status is. More...
any	ret () raises (CCallError)
	Returns only the return value, when checkStatus() returns CSendSuccess. More...
void	checkArguments (in CAnyArguments args) raises ( CWrongNumbArgException, CWrongTypeArgException)
	Checks if this handle returns these arguments in collect() and collectIfDone(). More...
void	dispose ()
	Clients need to call this after they have finished using this CSendHandle object. More...

Detailed Description

A handler object that allows us to collect the results of a send.

Due to memory restrictions, a server may choose to cleanup a CSendHandle before or during collect() was called. This is equivalent to having a SendError.

Definition at line 86 of file OperationInterface.idl.

Member Function Documentation

void RTT::corba::CSendHandle::checkArguments	(	in CAnyArguments	args	)
raises	(	CWrongNumbArgException,
		CWrongTypeArgException
	)

Checks if this handle returns these arguments in collect() and collectIfDone().

You can use this to check if collect() or collectIfDone() return what you expect. If no exception is thrown, the arguments are of the correct number and type. The values in args are ignored and not stored, only the types of the anys are checked. One could obtain the same information by using COperationInterface::getCollectType() for 1..COperationInterface::getCollectArity().

CSendStatus RTT::corba::CSendHandle::checkStatus

(

)

Just checks what the status is.

CSendStatus RTT::corba::CSendHandle::collect	(	out CAnyArguments	args	)
raises	(	CCallError
	)

CSendStatus RTT::corba::CSendHandle::collectIfDone	(	out CAnyArguments	args	)
raises	(	CCallError
	)

void RTT::corba::CSendHandle::dispose

(

)

Clients need to call this after they have finished using this CSendHandle object.

After dispose(), this object may no longer be used.

any RTT::corba::CSendHandle::ret	(		)
raises	(	CCallError
	)

Returns only the return value, when checkStatus() returns CSendSuccess.

Convenient if the sent method only returns a value.

---

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

• rtt/transports/corba/OperationInterface.idl