Events Component implements the urn:jaus:jss:core:Events services. More...

#include <Events.h>

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

Inherited by openjaus::core::EventsBase.

Public Member Functions
OPENJAUS_DEPRECATED	Events ()

	Events (const std::string &name)

virtual	~Events ()

Public Member Functions inherited from openjaus::core::services::Events
	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::EventsInterface
virtual	~EventsInterface ()

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

Public Member Functions inherited from openjaus::core::services::Transport
	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))

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

	Transport (const std::string &name)

virtual	~Transport ()

Public Member Functions inherited from openjaus::model::Component
virtual	~Component ()

	Component (const std::string &name)

	Component (const Component &copy)

std::string	getName () const
	Accessor to get the value of name. More...

uint8_t	getAuthority () const
	Accessor to get the value of authority. More...

bool	setAuthority (uint8_t authority)
	Accessor to set value of authority. More...

const std::vector< StateMachineRunner *> &	getRunners () const
	Accessor to get the value of runners. More...

bool	setRunners (const StateMachineRunner &runners)
	Accessor to set value of runners. More...

const std::vector< transport::Interface *> &	getInterfaces () const
	Accessor to get the value of interfaces. More...

bool	setInterfaces (const transport::Interface &interfaces)
	Accessor to set value of interfaces. More...

SystemTree *	getSystemTree () const
	Accessor to get the value of systemTree. More...

bool	setSystemTree (SystemTree *systemTree)
	Accessor to set value of systemTree. More...

std::vector< Service >	getImplements () const
	Accessor to get the value of implements. More...

bool	setImplements (Service *implements)
	Accessor to set value of implements. More...

Component *	getInheritsFrom () const
	Accessor to get the value of inheritsFrom. More...

bool	setInheritsFrom (Component *inheritsFrom)
	Accessor to set value of inheritsFrom. More...

const ComponentInfo &	getInfo () const
	Accessor to get the value of info. More...

const transport::Address &	getAddress () const
	Accessor to get the value of address. More...

void	run ()
	Operation run. More...

void	stop ()
	Operation stop. More...

virtual std::string	toString () const

OPENJAUS_DEPRECATED	Component ()

OPENJAUS_DEPRECATED bool	setName (std::string name)

std::string	toXml (unsigned char level=0) const

Protected Member Functions
virtual void	configureServices ()

virtual void	startServices ()

virtual void	stopServices ()

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 ()

Protected Member Functions inherited from openjaus::core::Transport
transport::Interface *	getSubsystemJudpInterface ()

transport::Interface *	getNodeJudpInterface ()

transport::Interface *	getComponentJudpInterface ()

bool	isSubsInterfaceEnabled ()

bool	isNodeInterfaceEnabled ()

system::PriorityQueue *const	getReceiveQueue ()

virtual core::services::TransportSettingsInterface *	loadTransportSettings ()

virtual transport::AS5669::JudpSettingsInterface *	loadJudpSettings ()

virtual transport::Interface *	createSubsystemJudpInterface ()

virtual transport::Interface *	createNodeJudpInterface ()

virtual transport::Interface *	createComponentJudpInterface ()

Private Member Functions
void	configureEventsService ()

Additional Inherited Members
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::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::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...

Static Public Attributes inherited from openjaus::model::Component
static const uint8_t	DEFAULT_AUTHORITY = 127

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

model::State	receivingState

Protected Attributes inherited from openjaus::model::Component
uint8_t	authority

std::vector< StateMachineRunner *>	runners

std::vector< transport::Interface *>	interfaces

SystemTree *	systemTree

std::vector< Service >	implements

Component *	inheritsFrom

Detailed Description

The Events component provides an implementation of the following service(s). This component can be extended for customized functionality or used via instantiation.

Events Service

This service is used to set up event notifications. Since this service does not contain any messages and data on which events can be setup, it is useful only when derived by other services that contain messages and data on which events can be defined.

URI: urn:jaus:jss:core:Events

Version: 1.1