Provides static methods for the Liveness service. More...

#include <Liveness.h>

Inherits openjaus::core::LivenessInterface, and openjaus::core::services::Events.

Inherited by openjaus::core::EventsBase [virtual].

Public Member Functions
	Liveness ()

virtual	~Liveness ()

virtual ReportHeartbeatPulse	getReportHeartbeatPulse (QueryHeartbeatPulse *queryHeartbeatPulse)
	Send a Report Heartbeat Pulse message to the component that sent the query Send a Report Heartbeat Pulse message to the component that sent the query. More...

virtual bool	processHeartbeat (ReportHeartbeatPulse *reportHeartbeatPulse)
	Processes ReportHeatbeat Messages to see if a new JAUS entity exists Processes ReportHeatbeat Messages to see if a new JAUS entity exists. More...

virtual bool	processStopped (ReportStopped *reportStopped)
	Processes ReportStopped Messages Processes ReportStopped Messages. More...

Public Member Functions inherited from openjaus::core::LivenessInterface
virtual	~LivenessInterface ()

Public Member Functions inherited from openjaus::core::EventsInterface
virtual	~EventsInterface ()

Public Member Functions inherited from openjaus::core::TransportInterface
virtual	~TransportInterface ()

Public Member Functions inherited from openjaus::core::services::Events
	Events ()

virtual	~Events ()

virtual bool	createEvent (CreateEvent *createEvent)
	CreateEvent action with input CreateEvent. More...

virtual bool	processEvent (ProcessEventRequest *processEventRequest)
	ProcessEvent action with input ProcessEventRequest. More...

virtual bool	resetEventTimer (CreateEvent *createEvent)
	ResetEventTimer action with input CreateEvent. More...

virtual bool	resetEventTimer (UpdateEvent *updateEvent)
	ResetEventTimer action with input UpdateEvent. More...

virtual bool	updateEvent (CreateEvent *createEvent)
	UpdateEvent action with input CreateEvent. More...

virtual bool	updateEvent (UpdateEvent *updateEvent)
	UpdateEvent action with input UpdateEvent. More...

virtual bool	cancelEvent (CancelEvent *cancelEvent)
	CancelEvent action with input CancelEvent. More...

virtual bool	stopEventTimer (CancelEvent *cancelEvent)
	StopEventTimer action with input CancelEvent. More...

virtual RejectEventRequest	getRejectEventRequest (CreateEvent *createEvent)
	Send action for RejectEventRequest with input message CreateEvent. More...

virtual RejectEventRequest	getRejectEventRequest (UpdateEvent *updateEvent)
	Send action for RejectEventRequest with input message UpdateEvent. More...

virtual RejectEventRequest	getRejectEventRequest (CancelEvent *cancelEvent)
	Send action for RejectEventRequest with input message CancelEvent. More...

virtual ConfirmEventRequest	getConfirmEventRequest (CreateEvent *createEvent)
	Send action for ConfirmEventRequest with input message CreateEvent. More...

virtual ConfirmEventRequest	getConfirmEventRequest (UpdateEvent *updateEvent)
	Send action for ConfirmEventRequest with input message UpdateEvent. More...

virtual ConfirmEventRequest	getConfirmEventRequest (CancelEvent *cancelEvent)
	Send action for ConfirmEventRequest with input message CancelEvent. More...

virtual ReportEvents	getReportEvents (QueryEvents *queryEvents)
	Send action for ReportEvents with input message QueryEvents. More...

virtual ReportEventTimeout	getReportEventTimeout (QueryEventTimeout *queryEventTimeout)
	Send action for ReportEventTimeout with input message QueryEventTimeout. More...

virtual bool	confirmEvent (ConfirmEventRequest *confirmEventRequest)
	ConfirmEvent action with input ConfirmEventRequest. More...

virtual bool	rejectEvent (RejectEventRequest *rejectEventRequest)
	RejectEvent action with input RejectEventRequest. More...

virtual bool	handleIncomingEvent (Event *event)
	HandleIncomingEvent action with input Event. More...

virtual bool	handleReportEvents (ReportEvents *reportEvents)
	HandleReportEvents action with input ReportEvents. More...

virtual bool	isSupported (CreateEvent *createEvent)
	isSupported condition. More...

virtual bool	isSupported (UpdateEvent *updateEvent)
	isSupported condition. More...

virtual bool	eventExists (CreateEvent *createEvent)
	eventExists condition. More...

virtual bool	eventExists (UpdateEvent *updateEvent)
	eventExists condition. More...

virtual bool	eventExists (CancelEvent *cancelEvent)
	eventExists condition. More...

bool	createOutgoingPeriodicEvent (uint8_t eventId, double rateHz, model::Message *query)

bool	createOutgoingOnChangeEvent (uint8_t eventId, model::Message *query)

OPENJAUS_DEPRECATED bool	publish (model::Message *message)

OPENJAUS_DEPRECATED bool	unpublish (model::Message *message)

OPENJAUS_DEPRECATED bool	publish (uint16 messageId)

bool	publish (uint16 messageId, double maximumRate_Hz, model::ConnectionType type)

bool	unpublish (uint16 messageId)

bool	notifyChanged (uint16 messageId)

uint32_t	subscribePeriodic (transport::Address &address, model::Message *query, double rate_Hz)

uint32_t	subscribePeriodic (transport::Address &address, model::Message query, double rate_Hz, void(subscribeCallback)(const model::EventRequestResponseArgs &args))

uint32_t	subscribePeriodic (transport::Address &address, model::Message query, double rate_Hz, void(subscribeCallback)(void object, const model::EventRequestResponseArgs &args), void object)

uint32_t	subscribeOnChange (transport::Address &address, model::Message *query)

uint32_t	subscribeOnChange (transport::Address &address, model::Message query, void(subscribeCallback)(const model::EventRequestResponseArgs &args))

uint32_t	subscribeOnChange (transport::Address &address, model::Message query, void(subscribeCallback)(void object, const model::EventRequestResponseArgs &args), void object)

bool	unsubscribe (uint32_t subscriptionId)

bool	unsubscribe (uint32_t subscriptionId, void(*callback)(const model::EventRequestResponseArgs &args))

bool	unsubscribe (uint32_t subscriptionId, void(callback)(void object, const model::EventRequestResponseArgs &args), void *object)

bool	isActive (uint32 subscriptionId)

uint8	getEventId (uint32 subscriptionId)

double	getConfirmedRate_Hz (uint32 subscriptionId)

bool	updatePeriodic (uint32 subscriptionId, double rate_Hz)

Public Member Functions inherited from openjaus::core::services::Transport
	Transport ()

virtual	~Transport ()

virtual bool	enqueue (model::Trigger *trigger)
	Convert the destination address into an unsigned integer such that the ComponentID maps to the least significant byte, NodeID to the next least significant byte and SubsystemID maps onto the remaining two bytes of the integer. More...

virtual bool	broadcastLocalEnqueue (model::Trigger *trigger)
	Package the message as specified by the transport layer specification and send it to all endpoints in the local subsystem. More...

virtual bool	broadcastGlobalEnqueue (model::Trigger *trigger)
	Package the message as specified by the transport layer specification and send it to all endpoints on all subsystems. More...

virtual bool	sendMessage (model::Trigger *trigger)
	SendMessage action with input SendMessage. More...

virtual bool	broadcastToNode (model::Trigger *trigger)
	Broadcasts message to all components within the local node Broadcasts message to all components within the local node. More...

virtual bool	broadcastToSubsystem (model::Trigger *trigger)
	Broadcasts a given message to all nodes in the local subsystem (equivalent to broadcast local enqueue) Broadcasts a given message to all nodes in the local subsystem (equivalent to broadcast local enqueue) More...

virtual bool	broadcastToSystem (model::Trigger *trigger)
	Broadcasts the message to all subsystems on the JAUS network (equivalent to broadcast global enqueue) Broadcasts the message to all subsystems on the JAUS network (equivalent to broadcast global enqueue) More...

virtual bool	checkTransportPolicy (model::Trigger *trigger)
	CheckTransportPolicy action with input CheckTransportPolicy. More...

virtual ReportTransportPolicy	getReportTransportPolicy (QueryTransportPolicy *queryTransportPolicy)
	Send action for ReportTransportPolicy with input message QueryTransportPolicy. More...

virtual bool	storeTransportPolicy (ReportTransportPolicy *reportTransportPolicy)
	StoreTransportPolicy action with input ReportTransportPolicy. More...

model::State *	getCurrentState ()

void	addAckNakCallback (void(*callback)(const transport::AckNakEventArgs &args))
	Adds a static callback that will execute when an ACK/NAK events occurs on the JUDP Interface. More...

void	addAckNakCallback (void(callback)(void object, const transport::AckNakEventArgs &args), void *object)
	Adds a class callback that will execute when an ACK/NAK events occurs on the JUDP Interface. More...

template<class MessageType , class CallbackClass >
void	addMessageCallback (bool(CallbackClass::callback)(MessageType &messageRef), CallbackClass object)

template<class CallbackClass >
void	addMessageCallback (bool(CallbackClass::callback)(model::Trigger trigger), CallbackClass *object)

template<class MessageType >
void	addMessageCallback (bool(*callback)(MessageType &messageRef))

Static Public Member Functions
static const char *	uri ()
	The URI for the Service. More...

static model::Service *	create ()
	Builds a default instance of the Liveness Service and populates the URI and Version numbers. More...

Static Public Member Functions inherited from openjaus::core::LivenessInterface
static OPENJAUS_DEPRECATED model::Service	LivenessService ()
	Builds a default instance of the Liveness Service and populates the URI and Version numbers. More...

static OPENJAUS_DEPRECATED std::string	LivenessUri ()
	Static accessor for Service URI. More...

Static Public Member Functions inherited from openjaus::core::EventsInterface
static OPENJAUS_DEPRECATED model::Service	EventsService ()
	Builds a default instance of the Events Service and populates the URI and Version numbers. More...

static OPENJAUS_DEPRECATED std::string	EventsUri ()
	Static accessor for Service URI. More...

Static Public Member Functions inherited from openjaus::core::TransportInterface
static OPENJAUS_DEPRECATED model::Service	TransportService ()
	Builds a default instance of the Transport Service and populates the URI and Version numbers. More...

static OPENJAUS_DEPRECATED std::string	TransportUri ()
	Static accessor for Service URI. More...

Static Public Member Functions inherited from openjaus::core::services::Events
static const char *	uri ()
	The URI for the Service. More...

static model::Service *	create ()
	Builds a default instance of the Events Service and populates the URI and Version numbers. More...

Static Public Member Functions inherited from openjaus::core::services::Transport
static const char *	uri ()
	The URI for the Service. More...

static model::Service *	create ()
	Builds a default instance of the Transport Service and populates the URI and Version numbers. More...

Protected Member Functions
void	setSystemTree (model::SystemTree *systemTree)

void	configure (LivenessSettingsInterface *settings)

void	startService ()

void	stopService ()

Protected Member Functions inherited from openjaus::core::services::Events
void	configure (EventsSettingsInterface *settings)

void	startService ()

void	stopService ()

Protected Member Functions inherited from openjaus::core::services::Transport
void	configure (services::TransportSettingsInterface *settings)

void	setComponentAddress (transport::Address *address)

void	setReceiveQueue (system::PriorityQueue *queue)

void	setSubsInterface (transport::Interface *interface)

void	setNodeInterface (transport::Interface *interface)

void	setComponentInterface (transport::Interface *interface)

void	setJtcpInterface (transport::AS5669::JtcpInterface *interface)

void	fireEvent (model::InternalEvent *event)

void	sendToSelf (transport::Wrapper *wrapper)

transport::Address *&	getComponentAddress ()

Private Member Functions
void	handleHeartbeatTimeout (system::Timer *timer)

void	handleLivenessTimeout (system::Timer *timer)

void	broadcastReportStopped ()

void	removeComponent (const transport::Address &address)

Private Attributes
HeartbeatLoop	heartbeatLoop

model::SystemTree *	systemTree

LivenessSettingsInterface *	settings

short	hbSequenceNumber

system::Timer *	heartbeatTimer

system::Timer *	timeoutTimer

system::Mutex	timeoutTableMutex

std::map< transport::Address, int >	timeoutTable

Additional Inherited Members
Protected Attributes inherited from openjaus::core::services::Transport
model::StateMachine	receive

model::State	receivingState

Detailed Description

Constructor & Destructor Documentation

§ Liveness()

openjaus::core::services::Liveness::Liveness ( )

§ ~Liveness()

openjaus::core::services::Liveness::~Liveness ( )

virtual

Member Function Documentation

§ broadcastReportStopped()

void openjaus::core::services::Liveness::broadcastReportStopped ( )

private

§ configure()

void openjaus::core::services::Liveness::configure ( LivenessSettingsInterface * settings )

protected

§ create()

model::Service * openjaus::core::services::Liveness::create ( )

static

Returns: model::Service - The populated service.

§ getReportHeartbeatPulse()

core::ReportHeartbeatPulse openjaus::core::services::Liveness::getReportHeartbeatPulse ( QueryHeartbeatPulse * queryHeartbeatPulse )

virtual

Parameters

[in] queryHeartbeatPulse - Input Trigger.

Returns: ReportHeartbeatPulse Output Message.

Implements openjaus::core::LivenessInterface.

§ handleHeartbeatTimeout()

void openjaus::core::services::Liveness::handleHeartbeatTimeout ( system::Timer * timer )

private

§ handleLivenessTimeout()

void openjaus::core::services::Liveness::handleLivenessTimeout ( system::Timer * timer )

private

§ processHeartbeat()

bool openjaus::core::services::Liveness::processHeartbeat ( ReportHeartbeatPulse * reportHeartbeatPulse )

virtual

Parameters

[in] reportHeartbeatPulse - Input Trigger.

Returns: Whether the message was properly processed by this action.

Implements openjaus::core::LivenessInterface.

§ processStopped()

bool openjaus::core::services::Liveness::processStopped ( ReportStopped * reportStopped )

virtual

Parameters

[in] reportStopped - Input Trigger.

Returns: Whether the message was properly processed by this action.

Implements openjaus::core::LivenessInterface.

§ removeComponent()

void openjaus::core::services::Liveness::removeComponent ( const transport::Address & address )

private

§ setSystemTree()

void openjaus::core::services::Liveness::setSystemTree ( model::SystemTree * systemTree )

protected

§ startService()

void openjaus::core::services::Liveness::startService ( )

protected

§ stopService()

void openjaus::core::services::Liveness::stopService ( )

protected

§ uri()

const char * openjaus::core::services::Liveness::uri ( )

static

Returns: const char* - The URI.

Member Data Documentation

§ hbSequenceNumber

short openjaus::core::services::Liveness::hbSequenceNumber

private

§ heartbeatLoop

HeartbeatLoop openjaus::core::services::Liveness::heartbeatLoop

private

§ heartbeatTimer

system::Timer* openjaus::core::services::Liveness::heartbeatTimer

private

§ settings

LivenessSettingsInterface* openjaus::core::services::Liveness::settings

private

§ systemTree

model::SystemTree* openjaus::core::services::Liveness::systemTree

private

§ timeoutTable

std::map<transport::Address, int> openjaus::core::services::Liveness::timeoutTable

private

§ timeoutTableMutex

system::Mutex openjaus::core::services::Liveness::timeoutTableMutex

private

§ timeoutTimer

system::Timer* openjaus::core::services::Liveness::timeoutTimer

private

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

include/openjaus/core/Services/Liveness.h
src/openjaus/core/Services/Liveness.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ Liveness()

§ ~Liveness()

Member Function Documentation

§ broadcastReportStopped()

§ configure()

§ create()

§ getReportHeartbeatPulse()

§ handleHeartbeatTimeout()

§ handleLivenessTimeout()

§ processHeartbeat()

§ processStopped()

§ removeComponent()

§ setSystemTree()

§ startService()

§ stopService()

§ uri()

Member Data Documentation

§ hbSequenceNumber

§ heartbeatLoop

§ heartbeatTimer

§ settings

§ systemTree

§ timeoutTable

§ timeoutTableMutex

§ timeoutTimer