Skip to content

Commit 57f59d1

Browse files
docs: add missing history field for data publisher (#256)
Signed-off-by: Daniel Edwards <Daniel.Edwards@vector.com>
1 parent 4ce9e54 commit 57f59d1

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

docs/changelog/versions/latest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
- Improved the behavior of the `sil-kit-system-controller`, allowing single participants to drop out and rejoin before
1414
all required participants are connected without having to restart other required participants or the system controller.
15+
- `docs`: document the ability to override the history length of ``DataPublisher`` controllers in the participant configuration
1516

1617
## Added
1718

docs/configuration/services-configuration.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ DataPublishers
135135
DataPublishers:
136136
- Name: DataPublisher1
137137
Topic: SomeTopic1
138+
History: 1
138139
Labels:
139140
- Key: SomeKey
140141
Value: SomeValue
@@ -154,9 +155,15 @@ DataPublishers
154155
- The name of the data publisher.
155156
* - Topic
156157
- The topic on which the data publisher publishes its information. (optional)
158+
* - History
159+
- The history length determines if the last message published by this data publisher is cached
160+
and automatically sent to any new subscribers.
161+
Note that the value will replace the programmatically provided history length.
162+
The default for the programmatically provided history length is ``0``.
163+
If set, the value must be either ``0`` or ``1``. (optional)
157164
* - Labels
158-
- The labels determining matching subscribers with the same topic and media type. (optional)
159-
Note that these labels will replace all programmatically provided labels.
165+
- The labels determining matching subscribers with the same topic and media type.
166+
Note that these labels will replace all programmatically provided labels. (optional)
160167

161168

162169
.. _sec:cfg-participant-data-subscribers:

0 commit comments

Comments
 (0)