CI: Add silent cmake SonarCloud scan
[ric-plt/lib/rmr.git] / examples / README
1
2 This directory contains a few sample programmes which demonstrate
3 various aspects of how a user programme can use RMr to send
4 and/or receive messages.  These programmes are fairly simple
5 in nature, and in most cases error checking is not performed
6 to keep the code simple.  
7
8
9 Health Check
10         This is an example of how a health check process might
11         be implemented. It sends 1 or more messages to an RMR
12         application and waits for the response. The latency of
13         each round trip (mu-seconds) is written to the tty.
14         
15
16 Message echoer
17         This is a simple process which returns the received message
18         back to the sender, optionally changing the message type
19         while leaving all other parts of the message unchanged.
20         This is a good verification for applications like the
21         health checker.
22
23 Receiver
24         This is a simple receiver process which returns messages to
25         the sender when a specific type is sent.  Messages are checked
26         for accuracy when run with the example sender.
27
28 Sender
29         A small sender which puts in information that lets the receiver
30         confirm that the message was received correctly (simple checksum
31         on portions of the payload and RMR header data.