feat(API): Add subscription id and source retrieval

[ric-plt/lib/rmr.git] / doc / src / man / rmr.7.xfm

diff --git a/doc/src/man/rmr.7.xfm b/doc/src/man/rmr.7.xfm
index eab9b9a..2ff5e6c 100644 (file)
--- a/doc/src/man/rmr.7.xfm
+++ b/doc/src/man/rmr.7.xfm
@@ -1,6 +1,6 @@
 .if false
 ==================================================================================
-       Copyright (c) 2019 Nokia 
+       Copyright (c) 2019 Nokia
        Copyright (c) 2018-2019 AT&T Intellectual Property.
 
    Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +25,7 @@
 
 .** if formatting with tfm, the roff.im will cause roff output to be generated
 .** and rst.im will cause rst to be generated depending on OUTPUT_TYPE env
-.** var. 
+.** var.
 .** if formatting with pfm, then pretty postscript will be generated
 
 .gv e LIB lib
@@ -33,7 +33,7 @@
        .im &{lib}/generic_ps.im
 .ei
        .gv e OUTPUT_RST use_rst
-       .if .ev &use_rst 1 = 
+       .if .ev &use_rst 1 =
                .im &{lib}/rst.im
        .ei
                .im &{lib}/roff.im
@@ -47,13 +47,13 @@
        RMr -- Ric Message Router Library
 
 &h2(DESCRIPTION)
-RMr is a library which provides  a user application with the ability 
+RMr is a library which provides  a user application with the ability
 to send and receive messages to/from  other RMr based applications
 without having to understand the underlying messaging transport environment (e.g. Nanomsg)
 and without needing to know which other endpoint applications are currently
 available and accepting messages.
 To do this, RMr depends on a routing table generated by an external source.
-This table is used to determine the destination endpoint of each message sent by mapping the 
+This table is used to determine the destination endpoint of each message sent by mapping the
 message type T (supplied by the user application) to an endpoint entry.
 Once determined, the message is sent directly to the endpoint.
 The user application is unaware of which endpoint actually receives the
@@ -62,28 +62,28 @@ applications.
 
 &space
 RMr functions do provide for the ability to respond to the specific source
-instance of a message allowing for either a request response, or call 
-response relationship when needed.  
+instance of a message allowing for either a request response, or call
+response relationship when needed. 
 
 
 &h3(The Route Table)
-The library is supplied with a route table which maps message numbers to 
+The library is supplied with a route table which maps message numbers to
 endpoint groups such that each time a message of type T is sent, the message
-is delivered to one member of each group associated with T. 
+is delivered to one member of each group associated with T.
 For example, message type 2 might route to two different groups where
 group A consists of worker1 and worker2, while group B consists only of
 logger1.
 
 &space
 It is the responsibility of the route table generator to know which endpoints
-belong to which groups, and which groups accept which message types. 
+belong to which groups, and which groups accept which message types.
 Once understood, the route table generator publishes a table that is ingested
 by RMr and used for mapping messages to end points.
 
 &h3(Environment)
-To enable configuration of the library behaviour outside of direct user application 
-control, RMr supports a number of environment variables which provide information 
-to the library.  
+To enable configuration of the library behaviour outside of direct user application
+control, RMr supports a number of environment variables which provide information
+to the library. 
 The following is a list of the various environment variables, what they control
 and the defaults which RMr uses if undefined.
 
@@ -93,18 +93,18 @@ and the defaults which RMr uses if undefined.
        This should be the IP address assigned to the interface that RMr should listen
        on, and if not defined RMr will listen on all interfaces.
 
-&di(RMR_RTG_SVC) RMr opens a TCP listen socket using the port defined by this 
+&di(RMR_RTG_SVC) RMr opens a TCP listen socket using the port defined by this
        environment variable and expects that the route table generator process
-       will connect to this port. 
+       will connect to this port.
        If not supplied the port 4561 is used.
 
 &di(RMR_RTG_ISRAW) Is set to 1 if the route table generator is sending "plain" messages
        (not using RMr to send messages, 0 if the rtg is using RMr to send. The default
-       is 1 as we don't expect the rtg to use RMr. 
+       is 1 as we don't expect the rtg to use RMr.
 
-&di(RMR_SEED_RT) This is used to supply a static route table which can be used for 
+&di(RMR_SEED_RT) This is used to supply a static route table which can be used for
        debugging, testing, or if no route table generator process is being used to
-       supply the route table.  
+       supply the route table. 
        If not defined, no static table is used and RMr will not report &ital(ready)
        until a table is received.
 &end_dlist
@@ -118,6 +118,7 @@ rmr_call(3),
 rmr_free_msg(3),
 rmr_init(3),
 rmr_init_trace(3),
+rmr_get_src(3),
 rmr_get_trace(3),
 rmr_get_trlen(3),
 rmr_payload_size(3),