DtInfluenceDispatcherServiceInterface Class Reference

Abstract interface class to the influence dispatcher service. This service provides DtInfluenceEvent instances to registered entities. It provides them in a more efficient manner than getting them directly from the DtEventManager.

Inheritance diagram for DtInfluenceDispatcherServiceInterface:

Public Types
typedef void(*	DtInfluenceEventFunction )(DtBoost::shared_ptr< const makVrfEvents::DtInfluenceEvent > influenceEvent, void *usr)

Public Member Functions
	DtInfluenceDispatcherServiceInterface ()
virtual void	registerForInfluenceEvents (const DtUUID &uuid, DtInfluenceEventFunction func, void *userData)=0
virtual void	unregisterForInfluenceEvents (const DtUUID &uuid, DtInfluenceEventFunction func, void *userData)=0
virtual void	registerForEventsByInfluenceName (const std::string &sInfluenceName, DtInfluenceEventFunction func, void *userData)=0
virtual void	unregisterForEventsByInfluenceName (const std::string &sInfluenceName, DtInfluenceEventFunction func, void *userData)=0

Private Member Functions
	DtInfluenceDispatcherServiceInterface (const DtInfluenceDispatcherServiceInterface &)
DtInfluenceDispatcherServiceInterface &	operator= (const DtInfluenceDispatcherServiceInterface &)

Member Typedef Documentation

typedef void(* DtInfluenceDispatcherServiceInterface::DtInfluenceEventFunction)(DtBoost::shared_ptr< const makVrfEvents::DtInfluenceEvent > influenceEvent, void *usr)

Constructor & Destructor Documentation

DtInfluenceDispatcherServiceInterface::DtInfluenceDispatcherServiceInterface ( const DtInfluenceDispatcherServiceInterface &  )

private

DtInfluenceDispatcherServiceInterface::DtInfluenceDispatcherServiceInterface

(

)

Member Function Documentation

DtInfluenceDispatcherServiceInterface& DtInfluenceDispatcherServiceInterface::operator= ( const DtInfluenceDispatcherServiceInterface &  )

private

virtual void DtInfluenceDispatcherServiceInterface::registerForInfluenceEvents ( const DtUUID &  uuid, DtInfluenceEventFunction  func, void *  userData  )

pure virtual

Register to receive callbacks for influence events addressed to a specific UUID.

Implemented in DtInfluenceEventDispatcher.

virtual void DtInfluenceDispatcherServiceInterface::unregisterForInfluenceEvents ( const DtUUID &  uuid, DtInfluenceEventFunction  func, void *  userData  )

pure virtual

Remove a callback registered with registerForInfluenceEvents()

Implemented in DtInfluenceEventDispatcher.

virtual void DtInfluenceDispatcherServiceInterface::registerForEventsByInfluenceName ( const std::string &  sInfluenceName, DtInfluenceEventFunction  func, void *  userData  )

pure virtual

Register for influence event callbacks based on influence name. This allows subscribers to receive influence events addressed to other recipients. Meaning, it does not filter by UUID.

Implemented in DtInfluenceEventDispatcher.

virtual void DtInfluenceDispatcherServiceInterface::unregisterForEventsByInfluenceName ( const std::string &  sInfluenceName, DtInfluenceEventFunction  func, void *  userData  )

pure virtual

Register for influence event callbacks based on influence name. This allows subscribers to receive influence events addressed to other recipients. Meaning, it does not filter by UUID.

Implemented in DtInfluenceEventDispatcher.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfcore/influenceDispatcherServiceInterface.h