Provides an abstract interface for the Liveness service. More...

#include <LivenessInterface.h>

Inherits openjaus::core::EventsInterface.

Inherited by openjaus::core::services::Liveness [virtual].

Public Member Functions
virtual	~LivenessInterface ()

virtual ReportHeartbeatPulse	getReportHeartbeatPulse (QueryHeartbeatPulse *queryHeartbeatPulse)=0
	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)=0
	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)=0
	Processes ReportStopped Messages Processes ReportStopped Messages. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual bool	enqueue (model::Trigger *trigger)=0
	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)=0
	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)=0
	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)=0
	SendMessage action with input SendMessage. More...

virtual bool	broadcastToNode (model::Trigger *trigger)=0
	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)=0
	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)=0
	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)=0
	CheckTransportPolicy action with input CheckTransportPolicy. More...

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

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

Static Public Member Functions
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...

Detailed Description

This service provides a means to maintain connection liveness between communicating components.

URI: urn:jaus:jss:core:Liveness

Version: 1.0

Inherits From:

urn:jaus:jss:core:Events

Constructor & Destructor Documentation

§ ~LivenessInterface()

virtual openjaus::core::LivenessInterface::~LivenessInterface ( )

inlinevirtual

Member Function Documentation

§ getReportHeartbeatPulse()

virtual ReportHeartbeatPulse openjaus::core::LivenessInterface::getReportHeartbeatPulse ( QueryHeartbeatPulse * queryHeartbeatPulse )

pure virtual

Parameters

[in] queryHeartbeatPulse - Input Trigger.

Returns: ReportHeartbeatPulse Output Message.

Implemented in openjaus::core::services::Liveness.

§ LivenessService()

static OPENJAUS_DEPRECATED model::Service openjaus::core::LivenessInterface::LivenessService ( )

inlinestatic

Returns: model::Service - The populated service.

§ LivenessUri()

static OPENJAUS_DEPRECATED std::string openjaus::core::LivenessInterface::LivenessUri ( )

inlinestatic

Returns: std::string - Service URI

§ processHeartbeat()

virtual bool openjaus::core::LivenessInterface::processHeartbeat ( ReportHeartbeatPulse * reportHeartbeatPulse )

pure virtual

Parameters

[in] reportHeartbeatPulse - Input Trigger.

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

Implemented in openjaus::core::services::Liveness.

§ processStopped()

virtual bool openjaus::core::LivenessInterface::processStopped ( ReportStopped * reportStopped )

pure virtual

Parameters

[in] reportStopped - Input Trigger.

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

Implemented in openjaus::core::services::Liveness.

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

include/openjaus/core/LivenessInterface.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

§ ~LivenessInterface()

Member Function Documentation

§ getReportHeartbeatPulse()

§ LivenessService()

§ LivenessUri()

§ processHeartbeat()

§ processStopped()