CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdApLongTransactionReactor Class Reference

#include <ApLongTransactions.h>

Inheritance diagram for OdApLongTransactionReactor:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdApLongTransactionReactor)
 
 OdApLongTransactionReactor ()
 
virtual void beginCheckOut (OdDbLongTransaction &lt, OdDbObjectIdArray &originList)
 
virtual void endCheckOut (OdDbLongTransaction &)
 
virtual void beginCheckIn (OdDbLongTransaction &)
 
virtual void endCheckIn (OdDbLongTransaction &)
 
virtual void abortLongTransaction (OdDbLongTransaction &)
 
- 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
 

Protected Member Functions

OdResult veto ()
 

Friends

class OdApLongTransactionManagerImpl
 

Additional Inherited Members

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

Detailed Description

This class is used to access callbacks for long transactions.

<group OdAp_Classes>

Definition at line 41 of file ApLongTransactions.h.

Constructor & Destructor Documentation

◆ OdApLongTransactionReactor()

OdApLongTransactionReactor::OdApLongTransactionReactor ( )

Member Function Documentation

◆ abortLongTransaction()

virtual void OdApLongTransactionReactor::abortLongTransaction ( OdDbLongTransaction & )
virtual

This notification is fired before long transaction is aborted in case of any errors.

◆ beginCheckIn()

virtual void OdApLongTransactionReactor::beginCheckIn ( OdDbLongTransaction & )
virtual

This notification is fired at the start of OdApLongTransactionManager::checkIn().

◆ beginCheckOut()

virtual void OdApLongTransactionReactor::beginCheckOut ( OdDbLongTransaction & lt,
OdDbObjectIdArray & originList )
virtual

This notification is fired at the start of OdApLongTransactionManager::checkOut().

Parameters
lt[in] Long transaction that this notification refers to.
originList[in, out] List of objects passed to OdApLongTransactionManager::checkOut(). Can be modified.

◆ endCheckIn()

virtual void OdApLongTransactionReactor::endCheckIn ( OdDbLongTransaction & )
virtual

This notification is fired at the end of OdApLongTransactionManager::checkIn().

◆ endCheckOut()

virtual void OdApLongTransactionReactor::endCheckOut ( OdDbLongTransaction & )
virtual

This notification is fired at the end of OdApLongTransactionManager::checkOut().

◆ ODRX_DECLARE_MEMBERS()

OdApLongTransactionReactor::ODRX_DECLARE_MEMBERS ( OdApLongTransactionReactor )

◆ veto()

OdResult OdApLongTransactionReactor::veto ( )
protected

You may call veto() from beginCheckOut() to abort transaction.

Friends And Related Symbol Documentation

◆ OdApLongTransactionManagerImpl

friend class OdApLongTransactionManagerImpl
friend

Definition at line 81 of file ApLongTransactions.h.


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