Add example health check example programmes
The example programs health check, and msg echo illustrate
how a simple RMR based health check application might be
implemented.
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I4962db7f65c650c00b2a74e1e3c5e71a27cdedfc
diff --git a/examples/README b/examples/README
index 4b63eee..7d523fd 100644
--- a/examples/README
+++ b/examples/README
@@ -4,3 +4,28 @@
and/or receive messages. These programmes are fairly simple
in nature, and in most cases error checking is not performed
to keep the code simple.
+
+
+Health Check
+ This is an example of how a health check process might
+ be implemented. It sends 1 or more messages to an RMR
+ application and waits for the response. The latency of
+ each round trip (mu-seconds) is written to the tty.
+
+
+Message echoer
+ This is a simple process which returns the received message
+ back to the sender, optionally changing the message type
+ while leaving all other parts of the message unchanged.
+ This is a good verification for applications like the
+ health checker.
+
+Receiver
+ This is a simple receiver process which returns messages to
+ the sender when a specific type is sent. Messages are checked
+ for accuracy when run with the example sender.
+
+Sender
+ A small sender which puts in information that lets the receiver
+ confirm that the message was received correctly (simple checksum
+ on portions of the payload and RMR header data.