Cpl::Itc::CloseApi Class Reference

This abstract class defines an close interface. More...

Detailed Description

This abstract class defines an close interface.

This close interface provides the ability to run an "clean-up/close" routine for a ITC server object IN its native thread (i.e. the thread that the ITC server object executes its ITC requests in). The close call is a SYNCHRONOUS ITC call. This has the following effects/requirements:

1) The caller MUST be in a different thread than the thread of the object being closed.

2) The thread of the caller will block until the ITC server object has completed its clean-up (i.e. called returnToSender() on the Close Request message).

#include <CloseApi.h>

Inheritance diagram for Cpl::Itc::CloseApi:

Public Member Functions
virtual bool	close (void *args=nullptr)=0
	Synchronously closes/cleans-up the called object.
virtual	~CloseApi ()
	Virtual destructor.

Constructor & Destructor Documentation

~CloseApi()

virtual Cpl::Itc::CloseApi::~CloseApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

close()

virtual bool Cpl::Itc::CloseApi::close ( void *  args = nullptr )

pure virtual

Synchronously closes/cleans-up the called object.

The method returns if the close operation was successful.

Implemented in Cpl::Itc::CloseSync.

---

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

• Cpl/Itc/CloseApi.h