Safir::Dob::EntitySubscriber Class Reference

Interface to be implemented by subscribers of entities. More...

#include <Safir/Dob/Consumer.h>

Inheritance diagram for Safir::Dob::EntitySubscriber:

Collaboration diagram for Safir::Dob::EntitySubscriber:

Public Member Functions
virtual	~EntitySubscriber ()
	Virtual destructor is needed since we have virtual member functions. More...
virtual void	OnNewEntity (const Safir::Dob::EntityProxy entityProxy)=0
	Called when a new entity is available. More...
virtual void	OnUpdatedEntity (const Safir::Dob::EntityProxy entityProxy)=0
	Called when an entity is updated. More...
virtual void	OnDeletedEntity (const Safir::Dob::EntityProxy entityProxy, const bool deprecated)=0
	Called when an entity is deleted. More...
Public Member Functions inherited from Safir::Dob::Internal::ConsumerBase
virtual	~ConsumerBase ()

Detailed Description

Interface to be implemented by subscribers of entities.

Constructor & Destructor Documentation

virtual Safir::Dob::EntitySubscriber::~EntitySubscriber ( )

virtual

Virtual destructor is needed since we have virtual member functions.

Member Function Documentation

virtual void Safir::Dob::EntitySubscriber::OnDeletedEntity ( const Safir::Dob::EntityProxy  entityProxy, const bool  deprecated  )

pure virtual

Called when an entity is deleted.

Parameters

[in]	entityProxy	- Proxy object containing deleted entity information.
[in]	deprecated	- Deprecated flag.

virtual void Safir::Dob::EntitySubscriber::OnNewEntity ( const Safir::Dob::EntityProxy  entityProxy )

pure virtual

Called when a new entity is available.

Parameters

[in]

entityProxy

- Proxy object containing new entity and meta information.

virtual void Safir::Dob::EntitySubscriber::OnUpdatedEntity ( const Safir::Dob::EntityProxy  entityProxy )

pure virtual

Called when an entity is updated.

If Change Information is enabled for the subscription those entity members that are changed, compared to the previous received entity, will be marked as changed.

The entity owner handler id can be retreived by calling GetCallbackInfo.

Parameters

[in]

entityProxy

- Proxy object containing updated entity and meta information.