TwiceAsNice  2019-02-18
Public Member Functions | Private Attributes | List of all members
Nice::HeartbeatActor Class Reference

This PropertyActor forwards the heart beat of a property tree server to an unreachability detector. More...

#include <HeartbeatActor.h>

Inheritance diagram for Nice::HeartbeatActor:
Inheritance graph
Collaboration diagram for Nice::HeartbeatActor:
Collaboration graph

Public Member Functions

 HeartbeatActor (const std::string &name, Nice::ServiceUnreachabilityDetectorPtr detector)
 
virtual ~HeartbeatActor ()
 
virtual void init (const Nice::PropertyFooPtr &, Nice::PropertyAttrMap &)
 Initializer, called by the Property when it is applied. More...
 
virtual Nice::PropertyActorclone ()
 Abstract function clones a PropertyActor instance. More...
 
virtual Nice::CompletionState set (const Nice::Date &, const Nice::Any &newValue)
 Abstract function validates a value of a certain type. More...
 
virtual std::string name () const
 return actor name. More...
 
virtual std::string toString () const
 Cast the PropertyActor to a string. More...
 
- Public Member Functions inherited from Nice::PropertyActor
 PropertyActor ()
 Constructor. More...
 
virtual ~PropertyActor ()
 Destructor. More...
 
 PropertyActor ()
 Constructor. More...
 
virtual ~PropertyActor ()
 Destructor. More...
 

Private Attributes

Nice::ServiceUnreachabilityDetectorPtr detector_
 
std::string name_
 

Detailed Description

This PropertyActor forwards the heart beat of a property tree server to an unreachability detector.

Constructor & Destructor Documentation

◆ HeartbeatActor()

Nice::HeartbeatActor::HeartbeatActor ( const std::string &  name,
Nice::ServiceUnreachabilityDetectorPtr  detector 
)

◆ ~HeartbeatActor()

virtual Nice::HeartbeatActor::~HeartbeatActor ( )
inlinevirtual

Member Function Documentation

◆ clone()

Nice::PropertyActor * Nice::HeartbeatActor::clone ( )
virtual

Abstract function clones a PropertyActor instance.

Returns
Cloned instance.

Implements Nice::PropertyActor.

◆ init()

void Nice::HeartbeatActor::init ( const Nice::PropertyFooPtr _foo,
Nice::PropertyAttrMap _attrs 
)
virtual

Initializer, called by the Property when it is applied.

Implements Nice::PropertyActor.

◆ name()

std::string Nice::HeartbeatActor::name ( ) const
virtual

return actor name.

Returns
Stringified Property.

Implements Nice::PropertyActor.

◆ set()

Nice::CompletionState Nice::HeartbeatActor::set ( const Nice::Date _date,
const Nice::Any a 
)
virtual

Abstract function validates a value of a certain type.

The derived function process is called. The value passed by reference might be manipulated

Parameters
_aValue of Nice::Any
Returns
True if the value was evaluated/processe successfully.
Note
the set value a of Type Any is const because the calling property set method uses also a const reference !

Implements Nice::PropertyActor.

◆ toString()

std::string Nice::HeartbeatActor::toString ( ) const
virtual

Cast the PropertyActor to a string.

Returns
Stringified Property.

Implements Nice::PropertyActor.

Member Data Documentation

◆ detector_

Nice::ServiceUnreachabilityDetectorPtr Nice::HeartbeatActor::detector_
private

◆ name_

std::string Nice::HeartbeatActor::name_
private

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