EventsBase Component implements the urn:openjaus:core:DiscoveryClient, urn:jaus:jss:core:Discovery, urn:jaus:jss:core:Liveness, urn:openjaus:core:Configuration services.
More...
|
OPENJAUS_DEPRECATED | EventsBase () |
|
| EventsBase (const std::string &name) |
|
virtual | ~EventsBase () |
|
| DiscoveryClient () |
|
virtual | ~DiscoveryClient () |
|
virtual bool | processReportIdentification (ReportIdentification *reportIdentification) |
| Executed when a ReportIdentification message is received. More...
|
|
virtual bool | processReportConfiguration (ReportConfiguration *reportConfiguration) |
| Executed when a ReportConfiguration message is received. More...
|
|
virtual bool | processReportSubsystemList (ReportSubsystemList *reportSubsystemList) |
| Executed when a ReportSubsystemList message is received. More...
|
|
virtual bool | processReportServices (ReportServices *reportServices) |
| Executed when a ReportServices message is received. More...
|
|
virtual bool | processReportServiceList (ReportServiceList *reportServiceList) |
| Executed when a ReportServicesList message is received. More...
|
|
bool | broadcastQueryIdentificationToNode (SystemLevelEnumeration::SystemLevelEnum queryType) |
|
bool | broadcastQueryIdentificationToSubsystem (SystemLevelEnumeration::SystemLevelEnum queryType) |
|
bool | broadcastQueryIdentificationToSystem (SystemLevelEnumeration::SystemLevelEnum queryType) |
|
bool | queryIdentification (const openjaus::transport::Address &address, openjaus::core::SystemLevelEnumeration::SystemLevelEnum queryType) |
|
bool | queryConfiguration (const openjaus::transport::Address &address, openjaus::core::SystemLevelEnumeration::SystemLevelEnum queryType) |
|
bool | queryServiceListAllServices (const openjaus::transport::Address &address) |
|
bool | queryServiceList (const openjaus::transport::Address &address, openjaus::core::QSLSubsystemList &subsystemList) |
|
bool | registerServices (const openjaus::transport::Address &address) |
|
virtual | ~DiscoveryClientInterface () |
|
virtual | ~EventsInterface () |
|
virtual | ~TransportInterface () |
|
| 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) |
|
| 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)) |
|
| Discovery () |
|
virtual | ~Discovery () |
|
virtual bool | publishServices (RegisterServices *registerServices) |
| PublishServices action with input RegisterServices. More...
|
|
virtual ReportIdentification | getReportIdentification (QueryIdentification *queryIdentification) |
| Send a Report Identification message to the component that sent the query. More...
|
|
virtual ReportConfiguration | getReportConfiguration (QueryConfiguration *queryConfiguration) |
| Send a Report Configuration message to the component that sent the query. More...
|
|
virtual ReportSubsystemList | getReportSubsystemList (QuerySubsystemList *querySubsystemList) |
| Send a Report Subsystems List message to the component that sent the query. More...
|
|
virtual ReportServices | getReportServices (QueryServices *queryServices) |
| Send a Report Services message to the component that sent the query. More...
|
|
virtual ReportServiceList | getReportServiceList (QueryServiceList *queryServiceList) |
| Send a Report Service List message to the component that sent the query Send a Report Service List message to the component that sent the query. More...
|
|
void | startService () |
|
void | stopService () |
|
virtual | ~DiscoveryInterface () |
|
| 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...
|
|
virtual | ~LivenessInterface () |
|
| Configuration () |
|
virtual | ~Configuration () |
|
virtual bool | sendJausAddress (QueryJausAddress *queryJausAddress) |
| SendJausAddress action with input QueryJausAddress. More...
|
|
virtual bool | setThisJausAddress (ReportJausAddress *reportJausAddress) |
| SetThisJausAddress action with input ReportJausAddress. More...
|
|
void | setSystemTree (model::SystemTree *systemTree) |
|
void | configure (ConfigurationSettingsInterface *settings) |
|
void | startService () |
|
void | stopService () |
|
virtual | ~ConfigurationInterface () |
|
OPENJAUS_DEPRECATED | Events () |
|
| Events (const std::string &name) |
|
virtual | ~Events () |
|
OPENJAUS_DEPRECATED | Transport () |
|
| Transport (const std::string &name) |
|
virtual | ~Transport () |
|
virtual | ~Component () |
|
| Component (const std::string &name) |
|
| Component (const Component ©) |
|
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 |
|
The EventsBase component provides an implementation of the following service(s). This component can be extended for customized functionality or used via instantiation.
- DiscoveryClient Service
-
This is a service which only implements the "client" side protocol of the Discovery process.
URI: urn:openjaus:core:DiscoveryClient
Version: 1.0
- Inherits From:
- urn:jaus:jss:core:Events
- Discovery Service
-
The process of discovery is conducted at both the node level and the subsystem level. service supports the discovery of both legacy components defined in the JAUS Reference Architecture versions 3.2+, and new components. The Component IDs of legacy components were fixed at specification time (Primitive Driver = 33 for example) and could contain only one service beyond the core service support. New components may use any component ID that is outside the range of IDs that have been allocated to legacy component definitions. New components can also contain two or more services beyond the core service support.
URI: urn:jaus:jss:core:Discovery
Version: 1.0
- Inherits From:
- urn:jaus:jss:core:Events
- Liveness Service
-
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
- Configuration Service
-
The Configuration Service provides runtime configuration of JAUS addresses using a discovery process which uses non-JAUS messages sent over JUDP.
URI: urn:openjaus:core:Configuration
Version: 1.0
- Inherits From:
- urn:jaus:jss:core:Events