maci::HeartbeatHandler

NAME
SYNOPSIS
Detailed Description
Constructor & Destructor Documentation
Member Function Documentation
Member Data Documentation
Author

NAME

maci::HeartbeatHandler −

SYNOPSIS

#include <maciHeartbeatController.h>

Public Member Functions

HeartbeatHandler (HeartbeatController *controller, maci::Handle handle, maci::Client_ptr client)

virtual int handle_timeout (const ACE_Time_Value &currentTime, const void *arg)

virtual int handle_close (ACE_HANDLE, ACE_Reactor_Mask)

void setTimerID (long timerID)

long getTimerID ()

void updateClient (maci::Client_ptr client)

Private Attributes

maci::Handle m_handle

Client’s handle.

long m_timerID

Thread timer id.

int m_failureCount

Failure count.

maci::Client_var m_client

Client’s reference.

HeartbeatController * m_controller

Heartbeat Controller that created me (parent).

Static Private Attributes

static int m_failureLimit

Failure limit.

Detailed Description

Event handler for the timer queue timeout events. The handle_timeout hook method is inovked the the timer times out...

Author:

Matej Sekoranja, Jozef Stefan Institute, Slovenia

Version:

Constructor & Destructor Documentation

maci::HeartbeatHandler::HeartbeatHandler (HeartbeatController * controller, maci::Handle handle, maci::Client_ptr client) Contructor.

Parameters:

controller parent controller.
handle
clients handle.
client
client reference.

Member Function Documentation

long maci::HeartbeatHandler::getTimerID () Returns timer ID.

Returns:

timer ID.

virtual int maci::HeartbeatHandler::handle_close (ACE_HANDLE, ACE_Reactor_Mask) [virtual] Callback hook, called when the timer is cancelled.

Returns:

0 is cancellation was successfull

virtual int maci::HeartbeatHandler::handle_timeout (const ACE_Time_Value & currentTime, const void * arg) [virtual] Callback hook.

Parameters:

currentTime current time.

Returns:

0 to normaly proceed, -1 to indicate timer thread to call ’cancel’ on this handle.

void maci::HeartbeatHandler::setTimerID (long timerID) Sets timer ID.

Parameters:

timerID timer ID.

void maci::HeartbeatHandler::updateClient (maci::Client_ptr client) Updates client.

Parameters:

client client reference.

Member Data Documentation

maci::Client_var maci::HeartbeatHandler::m_client [private]

Client’s reference.

HeartbeatController* maci::HeartbeatHandler::m_controller [private]

Heartbeat Controller that created me (parent).

int maci::HeartbeatHandler::m_failureCount [private]

Failure count.

int maci::HeartbeatHandler::m_failureLimit [static, private]

Failure limit.

maci::Handle maci::HeartbeatHandler::m_handle [private]

Client’s handle.

long maci::HeartbeatHandler::m_timerID [private]

Thread timer id.

Author

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.