Skip to content

Commit 31efa93

Browse files
committed
PVA readme: Update search detail; mention beacon & search cmd line tools
1 parent c23ba10 commit 31efa93

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

core/pva/README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,15 @@ the tools provided by EPICS base:
130130
pvget demo
131131
pvmonitor demo
132132

133+
Protocol Test Tools
134+
-------------------
133135

136+
`pvasearchmonitor` or invoking the phoebus command line with `-main org.epics.pva.server.PVASearchMonitorMain`
137+
starts a tool that periodically lists received search requests.
138+
139+
`pvaclient beacons` or invoking the phoebus command line with `-main org.epics.pva.client.PVAClientMain beacons`
140+
starts a tool that lists received beacons.
141+
134142

135143
API Documentation
136144
-----------------
@@ -146,10 +154,15 @@ PVA Client:
146154

147155
* PVA Server list
148156
* Maintains pool of PVs
149-
* Registers new PVs with ChannelSearch
150-
* ChannelSearch: Exponential backup to ~30 seconds
157+
* Registers new PVs with ChannelSearch, which supports UDP and TCP searches,
158+
i.e. search via broadcast/multicast/unicase or via a name server
159+
* ChannelSearch: Linear backup of 1, 2, 3, .. seconds between repeated
160+
searches, setting to searching once every 30 seconds after about 7 minutes
161+
* Clients monitor beacons. If the search has settled to once every 30 seconds,
162+
any new beacon restarts the linear backup to facilitate faster reconnect.
163+
Beacons are not required for a reconnect, but they may accelerate it
151164
* Forward unicast searches to local multicast group
152-
* Creates TCPHandler when channel found.
165+
* Creates TCPHandler when channel found
153166
* Support "anonymous" or "ca"
154167
(with user from "user.name" property and host from InetAddress.getLocalHost().getHostName())
155168
* Echo test when no new data for a while,
@@ -184,4 +197,5 @@ PVA Server:
184197
TODO:
185198

186199
* Testing
200+
* Implement beacons in server
187201
* Handle fixed size or bounded arrays?

0 commit comments

Comments
 (0)