VMware GemFire Native Client C++ API Reference

VMware VMware GemFire Native C++ Reference: apache::geode::client::RegionEvent Class Reference
VMware VMware GemFire Native C++ Reference 10.4.3
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
apache::geode::client::RegionEvent Class Reference

Declares region events. More...

#include <RegionEvent.hpp>

Public Member Functions

std::shared_ptr< Serializable > getCallbackArgument () const
 Returns the callbackArgument passed to the method that generated this event.
 
std::shared_ptr< Region > getRegion () const
 Return the region this event occurred in.
 
 RegionEvent ()
 Constructor.
 
 RegionEvent (const std::shared_ptr< Region > &region, const std::shared_ptr< Serializable > &aCallbackArgument, const bool remoteOrigin)
 Constructor, given the values.
 
bool remoteOrigin () const
 If the event originated in a remote process, returns true.
 
 ~RegionEvent ()
 Destructor.
 

Protected Attributes

const std::shared_ptr< Serializable > m_callbackArgument
 Callback argument for this event, if any.
 
const std::shared_ptr< Region > m_region
 Region for this event.
 
const bool m_remoteOrigin
 True if from a remote process.
 

Detailed Description

Declares region events.

Constructor & Destructor Documentation

◆ RegionEvent() [1/2]

apache::geode::client::RegionEvent::RegionEvent ( )

Constructor.

◆ RegionEvent() [2/2]

apache::geode::client::RegionEvent::RegionEvent ( const std::shared_ptr< Region > &  region,
const std::shared_ptr< Serializable > &  aCallbackArgument,
const bool  remoteOrigin 
)

Constructor, given the values.

◆ ~RegionEvent()

apache::geode::client::RegionEvent::~RegionEvent ( )

Destructor.

Member Function Documentation

◆ getCallbackArgument()

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

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

See the Region interface methods that take a callbackArgument parameter.

◆ getRegion()

std::shared_ptr< Region > apache::geode::client::RegionEvent::getRegion ( ) const
inline

Return the region this event occurred in.

◆ remoteOrigin()

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

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

Field Documentation

◆ m_callbackArgument

const std::shared_ptr<Serializable> apache::geode::client::RegionEvent::m_callbackArgument
protected

Callback argument for this event, if any.

◆ m_region

const std::shared_ptr<Region> apache::geode::client::RegionEvent::m_region
protected

Region for this event.

◆ m_remoteOrigin

const bool apache::geode::client::RegionEvent::m_remoteOrigin
protected

True if from a remote process.

Apache Geode C++ Cache API Documentation