Pivotal GemFire Native Client Cache Reference  9.0.6
gemfire::EntryEvent Class Reference

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

Inherits gemfire::SharedBase.

Public Member Functions

 EntryEvent (const RegionPtr &region, const CacheableKeyPtr &key, const CacheablePtr &oldValue, const CacheablePtr &newValue, const UserDataPtr &aCallbackArgument, const bool remoteOrigin)
 Constructor, given all values. More...
 
 EntryEvent ()
 Constructor. More...
 
UserDataPtr getCallbackArgument () const
 Returns the callbackArgument passed to the method that generated this event. More...
 
CacheableKeyPtr getKey () const
 
CacheablePtr getNewValue () const
 If the event is a destroy or invalidate operation, then the new value will be NULLPTR. More...
 
CacheablePtr getOldValue () const
 If the prior state of the entry was invalid, or non-existent/destroyed, then the old value will be NULLPTR. More...
 
RegionPtr getRegion () const
 
void preserveSB () const
 Atomically increment reference count. More...
 
int32_t refCount ()
 
void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. More...
 
bool remoteOrigin () const
 If the event originated in a remote process, returns true. More...
 
virtual ~EntryEvent ()
 Destructor. More...
 

Protected Attributes

UserDataPtr m_callbackArgument
 Callback argument for this event, if any. More...
 
CacheableKeyPtr m_key
 Cacheable key. More...
 
CacheablePtr m_newValue
 New value. More...
 
CacheablePtr m_oldValue
 Old value. More...
 
RegionPtr m_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

gemfire::EntryEvent::EntryEvent ( const RegionPtr region,
const CacheableKeyPtr key,
const CacheablePtr oldValue,
const CacheablePtr newValue,
const UserDataPtr aCallbackArgument,
const bool  remoteOrigin 
)

Constructor, given all values.

virtual gemfire::EntryEvent::~EntryEvent ( )
virtual

Destructor.

gemfire::EntryEvent::EntryEvent ( )

Constructor.

Member Function Documentation

UserDataPtr gemfire::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.

CacheableKeyPtr gemfire::EntryEvent::getKey ( ) const
inline
Returns
the key this event describes.
CacheablePtr gemfire::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
CacheablePtr gemfire::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.
RegionPtr gemfire::EntryEvent::getRegion ( ) const
inline
Returns
the region this event occurred in.
void gemfire::SharedBase::preserveSB ( ) const
inherited

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount ( )
inlineinherited
Returns
the reference count
void gemfire::SharedBase::releaseSB ( ) const
inherited

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.

bool gemfire::EntryEvent::remoteOrigin ( ) const
inline

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

Field Documentation

UserDataPtr gemfire::EntryEvent::m_callbackArgument
protected

Callback argument for this event, if any.

CacheableKeyPtr gemfire::EntryEvent::m_key
protected

Cacheable key.

CacheablePtr gemfire::EntryEvent::m_newValue
protected

New value.

CacheablePtr gemfire::EntryEvent::m_oldValue
protected

Old value.

RegionPtr gemfire::EntryEvent::m_region
protected
bool gemfire::EntryEvent::m_remoteOrigin
protected

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


GemFire C++ Cache API Documentation