gemfire_admin::CacheApplication Class Reference

Inherits gemfire::SharedBase.


Detailed Description

A cache application process managed by the Administration API.

Author:
Jim Nist

Public Member Functions

virtual void addLogListener (const LogListener *listener)=0
 Registers a listener that receives callbacks when a logged event takes place.
virtual const char * getDateTimeProcessStarted ()=0
 Gets a string representation of the date and time that the application started.
virtual const char * getHostAddress ()=0
 Gets the host address of this member as a string.
virtual const char * getHostName ()=0
 Gets the host name of this member as a string.
virtual const char * getId ()=0
 Gets a unique ID for this member.
virtual const bool getIsLinux ()=0
 Returns whether this member is running on Linux.
virtual const bool getIsWindows ()=0
 Returns whether this member is running on Windows.
virtual const char * getLicense ()=0
 Returns GemFire license information.
virtual const char * getLogLevel ()=0
 Retrieves this cache's Statistic resources.
virtual const char * getLogTail (uint32_t lines=80)=0
 Returns the tail of this manage entity's log file.
virtual const char * getMemberType ()=0
 Returns a text description of the Operating System, including version.
virtual const char * getName ()=0
 Returns a text name for the Cache Application.
virtual const char * getOperatingSystem ()=0
 Returns a text description of the Operating System, including version.
virtual void getRootRegions (VectorOfCacheRegion &root_regions)=0
 Returns gemfire::Regions belonging to this CacheApplication.
virtual bool getStatisticsEnabled ()=0
 Returns the StatisticsEnabled in this Cache Application.
virtual uint32_t getStatisticsInterval ()=0
 Gets the number of milliseconds between Statistic samples.
virtual const char * getVersion ()=0
 Returns this member's GemFire version information.
void preserveSB () const
 Atomically increment reference count.
int32_t refCount ()
 
Returns:
the reference count

virtual void refresh (bool refreshRootRegions)=0
 Updates the state of this Cache Application instance including Attributes and the Region tree.
void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
virtual void removeLogListener (const LogListener *listener)=0
 Unregisters a Log listener.
virtual void setStatisticsEnabled (bool enable)=0
 Sets StatisticsEnabled in this Cache Application.
virtual void setStatisticsInterval (uint32_t milliseconds)=0
 Sets the number of milliseconds between Statistic samples.

Member Function Documentation

virtual void gemfire_admin::CacheApplication::addLogListener ( const LogListener listener  )  [pure virtual]

Registers a listener that receives callbacks when a logged event takes place.

Parameters:
listener pointer to a listener class

virtual const char* gemfire_admin::CacheApplication::getDateTimeProcessStarted (  )  [pure virtual]

Gets a string representation of the date and time that the application started.

virtual const char* gemfire_admin::CacheApplication::getHostAddress (  )  [pure virtual]

Gets the host address of this member as a string.

virtual const char* gemfire_admin::CacheApplication::getHostName (  )  [pure virtual]

Gets the host name of this member as a string.

virtual const char* gemfire_admin::CacheApplication::getId (  )  [pure virtual]

Gets a unique ID for this member.

virtual const bool gemfire_admin::CacheApplication::getIsLinux (  )  [pure virtual]

Returns whether this member is running on Linux.

virtual const bool gemfire_admin::CacheApplication::getIsWindows (  )  [pure virtual]

Returns whether this member is running on Windows.

virtual const char* gemfire_admin::CacheApplication::getLicense (  )  [pure virtual]

Returns GemFire license information.

virtual const char* gemfire_admin::CacheApplication::getLogLevel (  )  [pure virtual]

Retrieves this cache's Statistic resources.

Parameters:
vectorOfStatisticResource pointer to return a vector of runtime Statistic resources
Returns:
true for successfully filling vectorOfStatisticResource, false for failure or if the member is not running Returns the logging level of the Cache Application.
See also:
getLogTail

addLogListener

virtual const char* gemfire_admin::CacheApplication::getLogTail ( uint32_t  lines = 80  )  [pure virtual]

Returns the tail of this manage entity's log file.

The 'lines' argument indicates the number of lines to return.

virtual const char* gemfire_admin::CacheApplication::getMemberType (  )  [pure virtual]

Returns a text description of the Operating System, including version.

virtual const char* gemfire_admin::CacheApplication::getName (  )  [pure virtual]

Returns a text name for the Cache Application.

virtual const char* gemfire_admin::CacheApplication::getOperatingSystem (  )  [pure virtual]

Returns a text description of the Operating System, including version.

virtual void gemfire_admin::CacheApplication::getRootRegions ( VectorOfCacheRegion root_regions  )  [pure virtual]

Returns gemfire::Regions belonging to this CacheApplication.

Parameters:
[out] root_regions vector for the list of Root Regions

virtual bool gemfire_admin::CacheApplication::getStatisticsEnabled (  )  [pure virtual]

Returns the StatisticsEnabled in this Cache Application.

virtual uint32_t gemfire_admin::CacheApplication::getStatisticsInterval (  )  [pure virtual]

Gets the number of milliseconds between Statistic samples.

virtual const char* gemfire_admin::CacheApplication::getVersion (  )  [pure virtual]

Returns this member's GemFire version information.

void gemfire::SharedBase::preserveSB (  )  const [inherited]

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount (  )  [inline, inherited]

Returns:
the reference count

virtual void gemfire_admin::CacheApplication::refresh ( bool  refreshRootRegions  )  [pure virtual]

Updates the state of this Cache Application instance including Attributes and the Region tree.

If a cache instance is closed refresh will not try to change the state of that instance and return false.

Parameters:
refreshRootRegions true to refresh the root regions

void gemfire::SharedBase::releaseSB (  )  const [inherited]

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

virtual void gemfire_admin::CacheApplication::removeLogListener ( const LogListener listener  )  [pure virtual]

Unregisters a Log listener.

Parameters:
listener pointer to a listener class

virtual void gemfire_admin::CacheApplication::setStatisticsEnabled ( bool  enable  )  [pure virtual]

Sets StatisticsEnabled in this Cache Application.

virtual void gemfire_admin::CacheApplication::setStatisticsInterval ( uint32_t  milliseconds  )  [pure virtual]

Sets the number of milliseconds between Statistic samples.


GemFire C++ Cache API Documentation