iberbox  2.1.1
iberbox::EventData Class Reference

The event data class. More...

Collaboration diagram for iberbox::EventData:

Public Types

enum  EventType {
  NEW_NODES, MOVED_NODE, DELETED_NODE, UPDATED_NODE,
  UPDATED_META, UPDATED_KEYS, LOGOUT, FULL_RELOAD,
  ACCOUNT_READY, CONNECTIVITY, ACCOUNT_INFO, LAST
}
 The event type enum. More...
 

Public Member Functions

AccountInfo getAccountInfo () const
 Gets the account info after the event occurred. More...
 
uint64_t getClientId () const
 Gets the Client Id object. More...
 
const char * getCloudState () const
 Gets the Cloud State object. More...
 
const char * getName () const
 Gets the Name object. More...
 
const std::string getNameString () const
 Gets the Name String object. More...
 
Node getNode () const
 Gets the node that caused the event. More...
 
uint64_t getNodeId () const
 Gets the Node Id object. More...
 
NodeList getNodeList () const
 Gets the Node List object. More...
 
int getNumber () const
 Gets the number associated to the event. More...
 
const char * getPath () const
 Gets the Path object. More...
 
const std::string getPathString () const
 Gets the Path String object. More...
 
Node getPreviousNode () const
 Gets the Previous Node object. More...
 
int getType () const
 Gets the event type. More...
 
bool isExternal () const
 
virtual ~EventData ()
 

Static Public Member Functions

static const char * getTypeName (unsigned type)
 Gets the event type name. More...
 
static const std::string getTypeNameString (unsigned type)
 Gets the event type name. More...
 

Detailed Description

The event data class.

Member Enumeration Documentation

◆ EventType

The event type enum.

Enumerator
NEW_NODES 
MOVED_NODE 
DELETED_NODE 
UPDATED_NODE 
UPDATED_META 
UPDATED_KEYS 
LOGOUT 
FULL_RELOAD 
ACCOUNT_READY 
CONNECTIVITY 
ACCOUNT_INFO 
LAST 

Constructor & Destructor Documentation

◆ ~EventData()

virtual iberbox::EventData::~EventData ( )
virtual

Referenced by getTypeNameString().

Member Function Documentation

◆ getAccountInfo()

AccountInfo iberbox::EventData::getAccountInfo ( ) const

Gets the account info after the event occurred.

Todo:
Returns
The account info after the event occurred.

Referenced by getTypeNameString().

◆ getClientId()

uint64_t iberbox::EventData::getClientId ( ) const

Gets the Client Id object.

Todo:
Returns
uint64_t

Referenced by getTypeNameString().

◆ getCloudState()

const char* iberbox::EventData::getCloudState ( ) const

Gets the Cloud State object.

Todo:
Returns
const char*

Referenced by getTypeNameString().

◆ getName()

const char* iberbox::EventData::getName ( ) const

Gets the Name object.

Todo:
Returns
const char*

Referenced by getTypeNameString().

◆ getNameString()

const std::string iberbox::EventData::getNameString ( ) const

Gets the Name String object.

Todo:
Returns
const std::string

Referenced by getTypeNameString().

◆ getNode()

Node iberbox::EventData::getNode ( ) const

Gets the node that caused the event.

Todo:
Returns
The node that caused the event.

Referenced by getTypeNameString().

◆ getNodeId()

uint64_t iberbox::EventData::getNodeId ( ) const

Gets the Node Id object.

Todo:
Returns
uint64_t

Referenced by getTypeNameString().

◆ getNodeList()

NodeList iberbox::EventData::getNodeList ( ) const

Gets the Node List object.

Todo:
Returns
NodeList

Referenced by getTypeNameString().

◆ getNumber()

int iberbox::EventData::getNumber ( ) const

Gets the number associated to the event.

Todo:
Returns
Number associated to the event

Referenced by getTypeNameString().

◆ getPath()

const char* iberbox::EventData::getPath ( ) const

Gets the Path object.

Todo:
Returns
const char*

Referenced by getTypeNameString().

◆ getPathString()

const std::string iberbox::EventData::getPathString ( ) const

Gets the Path String object.

Todo:
Returns
const std::string

Referenced by getTypeNameString().

◆ getPreviousNode()

Node iberbox::EventData::getPreviousNode ( ) const

Gets the Previous Node object.

Todo:
Returns
Node

Referenced by getTypeNameString().

◆ getType()

int iberbox::EventData::getType ( ) const

Gets the event type.

type valid values are described in EventType enum

Returns
int

Referenced by getTypeNameString().

◆ getTypeName()

static const char* iberbox::EventData::getTypeName ( unsigned  type)
inlinestatic

Gets the event type name.

type valid values are described in EventType enum

Parameters
typeThe event type.
Returns
The event type name as a char array.

References LAST.

Referenced by getTypeNameString().

◆ getTypeNameString()

static const std::string iberbox::EventData::getTypeNameString ( unsigned  type)
inlinestatic

Gets the event type name.

type valid values are described in EventType enum

Parameters
typeThe event type.
Returns
The event type as a std::string.

References getAccountInfo(), getClientId(), getCloudState(), getName(), getNameString(), getNode(), getNodeId(), getNodeList(), getNumber(), getPath(), getPathString(), getPreviousNode(), getType(), getTypeName(), isExternal(), and ~EventData().

◆ isExternal()

bool iberbox::EventData::isExternal ( ) const
Todo:
Returns
true if the event is external.
false if the event is not external.

Referenced by getTypeNameString().


The documentation for this class was generated from the following file: