CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdApcThread Class Referenceabstract

#include <RxThreadPoolService.h>

Inheritance diagram for OdApcThread:
OdRxObject

Public Member Functions

virtual void asyncProcCall (OdApcEntryPointVoidParam ep, OdApcParamType parameter)=0
 
virtual void asyncProcCall (OdApcEntryPointRxObjParam ep, OdRxObject *parameter)=0
 
virtual void wait (bool bNoThrow=false)=0
 
virtual unsigned int getId () const =0
 
virtual bool hasException () const =0
 
virtual void processException (bool bReThrow=true, bool bClear=true)=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This interface represents APC thread object. Corresponding C++ library: TD_DbRoot <group OdApc_Classes>

Definition at line 49 of file RxThreadPoolService.h.

Member Function Documentation

◆ asyncProcCall() [1/2]

virtual void OdApcThread::asyncProcCall ( OdApcEntryPointRxObjParam  ep,
OdRxObject parameter 
)
pure virtual

Execute atomic portion of code encapsulated as OdApcEntryPointRxObjParam and returns immediately.

Parameters
ep[in] Function pointer to execute.
parameter[in] Argument which will be passed into executed function.

◆ asyncProcCall() [2/2]

virtual void OdApcThread::asyncProcCall ( OdApcEntryPointVoidParam  ep,
OdApcParamType  parameter 
)
pure virtual

Execute atomic portion of code encapsulated as OdApcEntryPointVoidParam and returns immediately.

Parameters
ep[in] Function pointer to execute.
parameter[in] Argument which will be passed into executed function.

◆ getId()

virtual unsigned int OdApcThread::getId ( ) const
pure virtual

Returns thread's unique system identifier.

◆ hasException()

virtual bool OdApcThread::hasException ( ) const
pure virtual

Returns true in case if thread catched exception during execution.

◆ processException()

virtual void OdApcThread::processException ( bool  bReThrow = true,
bool  bClear = true 
)
pure virtual

Process exception, catched during thread exection.

Parameters
bReThrow[in] Throw exception (if it is exists) from inside this method.
bClear[in] Reset accumulated exception.

◆ wait()

virtual void OdApcThread::wait ( bool  bNoThrow = false)
pure virtual

Waits for completion of function execution in the current thread.

Parameters
bNoThrow[in] Disable exceptions throwing from inside this method.

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