hce-node application  1.4.3
HCE Hierarchical Cluster Engine node application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
HCE::handlers::ClientsQueueManager Class Reference

#include <ClientsQueueManager.hpp>

Public Member Functions

 ClientsQueueManager (std::vector< ClientWorkerItem > *queue, unsigned int purgeMode, HCE::handlers::ResourceUsageManager *resourceUsageManager=nullptr)
 Insert client at end of queue, reset expiry, client must not already be in queue.
void append (const std::string &identity, bool checkPresence=true)
 Insert client at end of queue, reset expiry, client must not already be in queue.
void append (const std::string &identity, const std::vector< ClientWorkerItem > &route, const std::string &resources, bool checkPresence=true)
 Insert client at end of queue, reset expiry, client must not already be in queue.
void append (const std::string &identity, const std::vector< ClientWorkerItem > &route, const ResourceUsageCollection &resources, bool checkPresence=true)
 Insert branch of clients at end of queue, reset expiry, client must not already be in queue.
void append (const std::vector< ClientWorkerItem > &queue)
 Insert client at end of queue with property value, client must not already be in queue.
void append (const std::string &identity, const std::string &property, bool checkPresence=true)
 Remove client from queue, if present.
void remove (const std::string &identity)
 Reset worker expiry, worker must be present.
bool refresh (const std::string &identity)
 Reset worker expiry, worker must be present.
bool refresh (const std::string &identity, const std::vector< ClientWorkerItem > &route, const std::string &resources="")
 Update property values, worker must be present.
bool refresh (const std::string &identity, const std::string &property)
 Look for & kill expired clients.
std::string purge (void)
 Existance registered client check.
bool exists (const std::string &identity)
 Returns dump of registered clients and current stats data.
std::string getDump (void) const
 Returns JSON of registered clients and current stats data.
std::string getAdminClients (void)
 Resets requests frequencies, increment counters.
void resetFrequencies (void)
 Increment requests frequencies.
void incrementFrequency (const std::string &identity)
 Get property values.
std::string getProperty (const std::string &identity)
 Get resources values as resource usage collection.
ResourceUsageCollection getResources (const std::string &identity)
 Get purge mode.
unsigned int getPurgeMode (void) const
 Set purge mode.
void setPurgeMode (const unsigned int purgeMode)
 Get heartbeat timeout.
unsigned int getHeartbeatTimeout (void) const
 Set heartbeat timeout.
void setHeartbeatTimeout (unsigned int heartbeatTimeout)
 Get heartbeat timeout.
unsigned int getMaxResourcesUsageCollectedSize (void) const
 Set heartbeat timeout.
void setMaxResourcesUsageCollectedSize (unsigned int maxResourcesUsageCollectedSize)

Detailed Description

Definition at line 27 of file ClientsQueueManager.hpp.

Constructor & Destructor Documentation

HCE::handlers::ClientsQueueManager::ClientsQueueManager ( std::vector< ClientWorkerItem > *  queue,
unsigned int  purgeMode,
HCE::handlers::ResourceUsageManager resourceUsageManager = nullptr 
)
inline

Insert client at end of queue, reset expiry, client must not already be in queue.

Definition at line 30 of file ClientsQueueManager.hpp.

Member Function Documentation

void HCE::handlers::ClientsQueueManager::append ( const std::string &  identity,
bool  checkPresence = true 
)
inline

Insert client at end of queue, reset expiry, client must not already be in queue.

Definition at line 39 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void HCE::handlers::ClientsQueueManager::append ( const std::string &  identity,
const std::vector< ClientWorkerItem > &  route,
const std::string &  resources,
bool  checkPresence = true 
)
inline

Insert client at end of queue, reset expiry, client must not already be in queue.

Definition at line 64 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

void HCE::handlers::ClientsQueueManager::append ( const std::string &  identity,
const std::vector< ClientWorkerItem > &  route,
const ResourceUsageCollection resources,
bool  checkPresence = true 
)
inline

Insert branch of clients at end of queue, reset expiry, client must not already be in queue.

Definition at line 97 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

void HCE::handlers::ClientsQueueManager::append ( const std::vector< ClientWorkerItem > &  queue)
inline

Insert client at end of queue with property value, client must not already be in queue.

Definition at line 126 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

void HCE::handlers::ClientsQueueManager::append ( const std::string &  identity,
const std::string &  property,
bool  checkPresence = true 
)
inline

Remove client from queue, if present.

Definition at line 134 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

bool HCE::handlers::ClientsQueueManager::exists ( const std::string &  identity)
inline

Returns dump of registered clients and current stats data.

Definition at line 272 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

std::string HCE::handlers::ClientsQueueManager::getAdminClients ( void  )
inline

Resets requests frequencies, increment counters.

Definition at line 296 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::string HCE::handlers::ClientsQueueManager::getDump ( void  ) const
inline

Returns JSON of registered clients and current stats data.

Definition at line 286 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

unsigned int HCE::handlers::ClientsQueueManager::getHeartbeatTimeout ( void  ) const
inline

Set heartbeat timeout.

Definition at line 356 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

unsigned int HCE::handlers::ClientsQueueManager::getMaxResourcesUsageCollectedSize ( void  ) const
inline

Set heartbeat timeout.

Definition at line 366 of file ClientsQueueManager.hpp.

std::string HCE::handlers::ClientsQueueManager::getProperty ( const std::string &  identity)
inline

Get resources values as resource usage collection.

Definition at line 322 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

unsigned int HCE::handlers::ClientsQueueManager::getPurgeMode ( void  ) const
inline

Set purge mode.

Definition at line 346 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

ResourceUsageCollection HCE::handlers::ClientsQueueManager::getResources ( const std::string &  identity)
inline

Get purge mode.

Definition at line 334 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

void HCE::handlers::ClientsQueueManager::incrementFrequency ( const std::string &  identity)
inline

Get property values.

Definition at line 312 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

std::string HCE::handlers::ClientsQueueManager::purge ( void  )
inline

Existance registered client check.

Definition at line 245 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

bool HCE::handlers::ClientsQueueManager::refresh ( const std::string &  identity)
inline

Reset worker expiry, worker must be present.

Definition at line 171 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::handlers::ClientsQueueManager::refresh ( const std::string &  identity,
const std::vector< ClientWorkerItem > &  route,
const std::string &  resources = "" 
)
inline

Update property values, worker must be present.

Definition at line 195 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

bool HCE::handlers::ClientsQueueManager::refresh ( const std::string &  identity,
const std::string &  property 
)
inline

Look for & kill expired clients.

Definition at line 223 of file ClientsQueueManager.hpp.

Here is the call graph for this function:

void HCE::handlers::ClientsQueueManager::remove ( const std::string &  identity)
inline

Reset worker expiry, worker must be present.

Definition at line 161 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

void HCE::handlers::ClientsQueueManager::resetFrequencies ( void  )
inline

Increment requests frequencies.

Definition at line 304 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

void HCE::handlers::ClientsQueueManager::setHeartbeatTimeout ( unsigned int  heartbeatTimeout)
inline

Get heartbeat timeout.

Definition at line 361 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

void HCE::handlers::ClientsQueueManager::setMaxResourcesUsageCollectedSize ( unsigned int  maxResourcesUsageCollectedSize)
inline

Definition at line 371 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:

void HCE::handlers::ClientsQueueManager::setPurgeMode ( const unsigned int  purgeMode)
inline

Get heartbeat timeout.

Definition at line 351 of file ClientsQueueManager.hpp.

Here is the caller graph for this function:


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