apache::geode::client::EntryEvent Class Reference

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

Inherits apache::geode::client::SharedBase.

Public Member Functions
	EntryEvent ()
	Constructor. More...
	EntryEvent (const RegionPtr &region, const CacheableKeyPtr &key, const CacheablePtr &oldValue, const CacheablePtr &newValue, const UserDataPtr &aCallbackArgument, const bool remoteOrigin)
	Constructor, given all values. 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

EntryEvent() [1/2]

apache::geode::client::EntryEvent::EntryEvent	(	const RegionPtr &	region,
		const CacheableKeyPtr &	key,
		const CacheablePtr &	oldValue,
		const CacheablePtr &	newValue,
		const UserDataPtr &	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()

UserDataPtr 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()

CacheableKeyPtr apache::geode::client::EntryEvent::getKey ( ) const

inline

Returns

the key this event describes.

getNewValue()

CacheablePtr 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()

CacheablePtr 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()

RegionPtr apache::geode::client::EntryEvent::getRegion ( ) const

inline

Returns

the region this event occurred in.

preserveSB()

void apache::geode::client::SharedBase::preserveSB ( ) const

inherited

Atomically increment reference count.

refCount()

int32_t apache::geode::client::SharedBase::refCount ( )

inlineinherited

Returns

the reference count

releaseSB()

void apache::geode::client::SharedBase::releaseSB ( ) const

inherited

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

remoteOrigin()

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

inline

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

Field Documentation

m_callbackArgument

UserDataPtr apache::geode::client::EntryEvent::m_callbackArgument

protected

Callback argument for this event, if any.

m_key

CacheableKeyPtr apache::geode::client::EntryEvent::m_key

protected

Cacheable key.

m_newValue

CacheablePtr apache::geode::client::EntryEvent::m_newValue

protected

New value.

m_oldValue

CacheablePtr apache::geode::client::EntryEvent::m_oldValue

protected

Old value.

m_region

RegionPtr apache::geode::client::EntryEvent::m_region

protected

Region.

m_remoteOrigin

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

protected

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