Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
Communications Backbone System
backbone-message-format
Commits
fd8fcdf3
Unverified
Commit
fd8fcdf3
authored
2 years ago
by
Dan Jones
Browse files
Options
Download
Email Patches
Plain Diff
docs: corrections to pubsub topic docs
parent
ddfe9b69
dev
41-add-optional-operating_area-as-a-wider-zone-outside-region_of_interest
42-add-event-details-and-status-to-acknowledgement-schema
66-tag-current-dev-as-version-1
76-should-depth-and-altitude-be-coordinates
80-add-informational-type-primitive
87-remove-comment-for-platform-status-state
87-remove-todo-comment-from-platform-state
action-refactor-test
ci-js-test
master
missionmonitor
v2.0.0
v2.0.0-beta.11
v2.0.0-beta.10
v2.0.0-beta.9
v2.0.0-beta.8
v2.0.0-beta.7
v2.0.0-beta.6
v2.0.0-beta.5
v2.0.0-beta.4
v2.0.0-beta.3
v2.0.0-beta.2
v2.0.0-beta.1
v1.0.0
v0.2.0
v0.1.0
2 merge requests
!17
Resolve "MQ Topic Structure with operator appointed name"
,
!16
Resolve "Release v0.1"
Pipeline
#111503
passed with stages
in 1 minute and 12 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
14 additions
and
15 deletions
+14
-15
README.md
README.md
+14
-15
No files found.
README.md
View file @
fd8fcdf3
...
...
@@ -17,16 +17,23 @@ Messages are routed using either a publish/subscribe or broadcast mechanism.
For published messages, the message is published for a given a topic.
Clients create a subscription to a topic pattern which may include wildcards.
Clients create a subscription (stored in their config) to a topic pattern which may include wildcards.
It's important to note that the client config documents the subscription. To change a client
subscription it must be updated with the backbone.
Messages with a topic matching a client's subscription pattern are delivered to that client.
Published messages are delivered to all clients where
the message topic matches the client's subscription
topic pattern.
Broadcast messages are delivered to all clients regardless of their subscription.
Broadcast messages are delivered to all clients regardless of their subscription.
### Field
The topic should be set in the
`message.header.destination`
for published messages.
The desintation field should be set to
`broadcast`
for any messages sent using broadcast.
The
`destination`
field should be set to
`broadcast`
for any messages sent using broadcast.
Because the
`destination`
field is a topic it defines what the message relates to - not
who the intended recipient is.
### Structure
...
...
@@ -39,21 +46,13 @@ e.g
### Terms
The
`header.destination`
field contains the topic that messages will be published to.
This is not the intended recipient of those messages.
The autonomy engine/frontend/c2s are not represented in the topic.
The topic describes what the message relates to.
The client
`subscription`
will define which clients receive a message.
*
`prefix`
- an agreed hard-coded/config setting prefix shared by all adapters and client subscriptions eg soar
*
`operator`
- human readable organisation name for the platform operator one of [noc|planet-ocean|hydrosurv]
*
`platform_type`
- one of [autosub|ecosub|reav?]
*
`platform_identifier`
- human readable identifier for the platform eg ah1, eco1, reav1
*
`to_platform|from_platform`
- eg ..to_platform.mission_plan, ..from_platform.platform_status
*
`to_platform|from_platform`
- eg ..to_platform.mission_plan, ..from_platform.platform_status
missions are sent
`to_platform`
to be executed and status updates are received
`from_platform`
containing
information about its position and health status
*
`message_type`
- one of
`[acknowledgement|mission_plan|observation|planning_configuration|platform_status...]`
### Subscriptions
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment