CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdApcQueue Class Referenceabstract

#include <RxThreadPoolService.h>

Inheritance diagram for OdApcQueue:
OdRxObject

Public Member Functions

virtual OdRxThreadPoolService & framework ()=0
 
virtual void setAtomPoolRef (OdApcObjectPool *pAtomPool)=0
 
virtual void addEntryPoint (OdApcAtom *pRecipient, OdRxObject *pMessage=0)=0
 
virtual void addEntryPoint (OdApcAtom *pRecipient, OdApcParamType pMessage)=0
 
virtual void wait ()=0
 
virtual void executeMainThreadAction (MainThreadFunc mtFunc, void *pArg)=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () 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 OdRxClass * desc ()
 

Detailed Description

This interface represents APC framework queue. Corresponding C++ library: TD_Db <group OdApc_Classes>

Definition at line 139 of file RxThreadPoolService.h.

Member Function Documentation

◆ addEntryPoint() [1/2]

virtual void OdApcQueue::addEntryPoint ( OdApcAtom *  pRecipient,
OdApcParamType  pMessage 
)
pure virtual

Adds atomic portion of code encapsulated in OdRxAtom to queue and returns immediately.

◆ addEntryPoint() [2/2]

virtual void OdApcQueue::addEntryPoint ( OdApcAtom *  pRecipient,
OdRxObject *  pMessage = 0 
)
pure virtual

Adds atomic portion of code encapsulated in OdRxAtom to queue and returns immediately.

◆ executeMainThreadAction()

virtual void OdApcQueue::executeMainThreadAction ( MainThreadFunc  mtFunc,
void *  pArg 
)
pure virtual

Execute action in the main thread (doesn't depend on multithread queues count).

Parameters
mtFunc[in] Function to execute in the main thread.
pArg[in] Function argument to execute in the main thread.
Remarks
Simply redirects call into threading framework.

◆ framework()

virtual OdRxThreadPoolService& OdApcQueue::framework ( )
pure virtual

Returns reference to the threading framework.

◆ setAtomPoolRef()

virtual void OdApcQueue::setAtomPoolRef ( OdApcObjectPool *  pAtomPool)
pure virtual

Sets reference to helper atom pool object, where every atom object is being put after APC call is returned.

◆ wait()

virtual void OdApcQueue::wait ( )
pure virtual

Waits until all OdApcAtom objects in main and synchronized queues are processed.

Remarks
Calling thread also utilized to process queued asynchronous calls.

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