Pivotal GemFire Native C++ Reference  10.2.0
apache::geode::client::EntryEvent Class Reference

Represents an entry event affecting an entry, including its identity and the the circumstances of the event. More...

Public Member Functions

 EntryEvent ()
 Constructor. More...
 
 EntryEvent (const std::shared_ptr< Region > &region, const std::shared_ptr< CacheableKey > &key, const std::shared_ptr< Cacheable > &oldValue, const std::shared_ptr< Cacheable > &newValue, const std::shared_ptr< Serializable > &aCallbackArgument, const bool remoteOrigin)
 Constructor, given all values. More...
 
std::shared_ptr< SerializablegetCallbackArgument () const
 Returns the callbackArgument passed to the method that generated this event. More...
 
std::shared_ptr< CacheableKeygetKey () const
 
std::shared_ptr< CacheablegetNewValue () const
 If the event is a destroy or invalidate operation, then the new value will be nullptr. More...
 
std::shared_ptr< CacheablegetOldValue () const
 If the prior state of the entry was invalid, or non-existent/destroyed, then the old value will be nullptr. More...
 
std::shared_ptr< RegiongetRegion () const
 
bool remoteOrigin () const
 If the event originated in a remote process, returns true. More...
 
virtual ~EntryEvent ()
 Destructor. More...
 

Protected Attributes

std::shared_ptr< Serializablem_callbackArgument
 Callback argument for this event, if any. More...
 
std::shared_ptr< CacheableKeym_key
 Cacheable key. More...
 
std::shared_ptr< Cacheablem_newValue
 New value. More...
 
std::shared_ptr< Cacheablem_oldValue
 Old value. More...
 
std::shared_ptr< Regionm_region
 Region. More...
 
bool m_remoteOrigin
 True if from a remote (non-local) process. More...
 

Detailed Description

Represents an entry event affecting an entry, including its identity and the the circumstances of the event.

Constructor & Destructor Documentation

◆ EntryEvent() [1/2]

apache::geode::client::EntryEvent::EntryEvent ( const std::shared_ptr< Region > &  region,
const std::shared_ptr< CacheableKey > &  key,
const std::shared_ptr< Cacheable > &  oldValue,
const std::shared_ptr< Cacheable > &  newValue,
const std::shared_ptr< Serializable > &  aCallbackArgument,
const bool  remoteOrigin 
)

Constructor, given all values.

◆ ~EntryEvent()

virtual apache::geode::client::EntryEvent::~EntryEvent ( )
virtual

Destructor.

◆ EntryEvent() [2/2]

apache::geode::client::EntryEvent::EntryEvent ( )

Constructor.

Member Function Documentation

◆ getCallbackArgument()

std::shared_ptr<Serializable> apache::geode::client::EntryEvent::getCallbackArgument ( ) const
inline

Returns the callbackArgument passed to the method that generated this event.

See the Region interface methods that take a callbackArgument parameter.

◆ getKey()

std::shared_ptr<CacheableKey> apache::geode::client::EntryEvent::getKey ( ) const
inline
Returns
the key this event describes.

◆ getNewValue()

std::shared_ptr<Cacheable> apache::geode::client::EntryEvent::getNewValue ( ) const
inline

If the event is a destroy or invalidate operation, then the new value will be nullptr.

Returns
the updated value from this event

◆ getOldValue()

std::shared_ptr<Cacheable> apache::geode::client::EntryEvent::getOldValue ( ) const
inline

If the prior state of the entry was invalid, or non-existent/destroyed, then the old value will be nullptr.

Returns
the old value in the cache.

◆ getRegion()

std::shared_ptr<Region> apache::geode::client::EntryEvent::getRegion ( ) const
inline
Returns
the region this event occurred in.

◆ remoteOrigin()

bool apache::geode::client::EntryEvent::remoteOrigin ( ) const
inline

If the event originated in a remote process, returns true.

Field Documentation

◆ m_callbackArgument

std::shared_ptr<Serializable> apache::geode::client::EntryEvent::m_callbackArgument
protected

Callback argument for this event, if any.

◆ m_key

std::shared_ptr<CacheableKey> apache::geode::client::EntryEvent::m_key
protected

Cacheable key.

◆ m_newValue

std::shared_ptr<Cacheable> apache::geode::client::EntryEvent::m_newValue
protected

New value.

◆ m_oldValue

std::shared_ptr<Cacheable> apache::geode::client::EntryEvent::m_oldValue
protected

Old value.

◆ m_region

std::shared_ptr<Region> apache::geode::client::EntryEvent::m_region
protected

◆ m_remoteOrigin

bool apache::geode::client::EntryEvent::m_remoteOrigin
protected

True if from a remote (non-local) process.


Apache Geode C++ Cache API Documentation