epics/pvDatabase
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

address ANL feedback

Browse Source
This commit is contained in:
Sinisa Veseli
2023-06-28 13:11:56 -05:00
parent 91d0d2c315
commit 00a8459944
2 changed files with 14 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/RELEASE_NOTES.md
View File

@ -10,7 +10,7 @@ This document summarizes the changes to the module between releases.
`_[distributor=group:<group id>;set:<set_id>;trigger:<field_name>;updates:<n_updates>;mode:<update_mode>]` `_[distributor=group:<group id>;set:<set_id>;trigger:<field_name>;updates:<n_updates>;mode:<update_mode>]`
The plugin parameters are described bellow: The plugin parameters are optional and are described bellow:
- group: this parameter indicates a group that client application belongs to (default value: "default"); groups of clients are completely independent of each other - group: this parameter indicates a group that client application belongs to (default value: "default"); groups of clients are completely independent of each other

29
documentation/dataDistributorPlugin.md
View File

@ -34,34 +34,31 @@ in which a particular client application is written.
The plugin parameters are the following: The plugin parameters are the following:
- group: this parameter indicates a group that client application belongs to - `group:<group_id>`: specifying a `group_id` names a group the client application belongs to (default value: `default`); clients with different group names are
(default value: "default"); groups of clients are completely independent completely independent of each other
of each other
- set: this parameter designates a client set that application belongs to - `set:<set_id>`: this parameter designates a client set that application belongs to within its group (default value: `default`)
within its group (default value: "default")
- trigger: this is the PV structure field that distinguishes - `trigger:<field_name>`: this is the PV structure field that distinguishes
different channel updates (default value: "timeStamp"); for example, different channel updates (default value: `timeStamp`); for example,
for area detector images one could use the "uniqueId" field of the NTND for area detector images one could use the `uniqueId` field of the NTND
structure structure
- updates: this parameter configures how many sequential updates - `updates:<n_updates>`: this parameter must be an integer and configures how many sequential updates a client (or a set of clients) will receive before the data distributor starts updating the next one (default value: `1`)
a client (or a set of clients) will receive before the data distributor
starts updating the next one (default value: "1")
- mode: this parameter configures how channel updates are to be - `mode:<update_mode>`: this parameter configures how channel updates are to be
distributed between clients in a set: distributed between clients in a set:
- one: update goes to one client per set - `one`: update goes to one client per set
- all: update goes to all clients in a set - `all`: update goes to all clients in a set
- default is "one" if client set id is not specified, and "all" if set - default is `one` if client set id is not specified, and `all` if set
id is specified id is specified
The plugin obeys the following rules: The plugin obeys the following rules:
- Parameter names are case insensitive, but the string values - Parameter names are case insensitive, but the string values
are not. For example, "group=abc" and "group=ABC" would indicate two are not. For example, "group=abc" and "group=ABC" would indicate two
different groups of clients. different groups of clients. String values allow alphanumeric characters,
as well as dashes and underscores.
- Updates for a set of clients are configured when the first client in - Updates for a set of clients are configured when the first client in
the set requests data. Configuration values (i.e., "trigger", the set requests data. Configuration values (i.e., "trigger",