2 ==================================================================================
3 Copyright (c) 2019 Nokia
4 Copyright (c) 2018-2019 AT&T Intellectual Property.
6 Licensed under the Apache License, Version 2.0 (the "License");
7 you may not use this file except in compliance with the License.
8 You may obtain a copy of the License at
10 http://www.apache.org/licenses/LICENSE-2.0
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS,
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 See the License for the specific language governing permissions and
16 limitations under the License.
17 ==================================================================================
21 Mnemonic: index_snarf.im
22 Abstract: Define all terms/synonyms whch {X}fm will yank and reference when
23 it builds the index (pfm only).
25 Author: E. Scott Daniels
30 .** ensure that index collection is going
34 .ix synonym context ctx
38 .ix snare `message type`
39 .ix synonym `message type` MT/SID
40 .ix synonym `message type` `message type,`
43 .ix synonym nanomsg Nanomsg
47 .ix snare `round robin`
48 .ix synonym `round robin` round-robin
49 .ix snare `route table`
51 .ix snare `subscription ID`
52 .ix synonym `subscription ID` `subscription ID,`
53 .ix synonym `subscription ID` `subID`
55 .ix snare `transaction ID`
56 .ix snare `trace data`
60 .** ---- functions --------
68 .ix snare rmr_send_msg
69 .ix snare rmr_init_trace
71 .ix snare rmr_wh_close
72 .ix snare rmr_wh_send_msg
74 .** ----- environment variables -----
78 .ix snare RMR_RTG_ISRAW
79 .ix snare RMR_VCTL_FILE
80 .ix snare RMR_SRC_NAMEONLY
82 .** ----- errors -------------------
85 .ix snare RMR_ERR_BADARG
86 .ix snare RMR_ERR_NOENDPT
87 .ix snare RMR_ERR_EMPTY
88 .ix snare RMR_ERR_NOHDR
89 .ix snare RMR_ERR_SENDFAILED
90 .ix snare RMR_ERR_CALLFAILED
91 .ix snare RMR_ERR_NOWHOPEN
92 .ix snare RMR_ERR_WHID
93 .ix snare RMR_ERR_OVERFLOW
94 .ix snare RMR_ERR_RETRY
95 .ix snare RMR_ERR_RCVFAILED
96 .ix snare RMR_ERR_TIMEOUT
97 .ix snare RMR_ERR_UNSET
98 .ix snare RMR_ERR_TRUNC
99 .ix snare RMR_ERR_NOTSUPP
103 .ix synonym OK RMR_OK
105 .ix synonym BADARG RMR_ERR_BADARG
107 .ix synonym NOENDPT RMR_ERR_NOENDPT
109 .ix synonym EMPTY RMR_ERR_EMPTY
111 .ix synonym NOHDR RMR_ERR_NOHDR
113 .ix synonym SENDFAILED RMR_ERR_SENDFAILED
115 .ix synonym CALLFAILED RMR_ERR_CALLFAILED
117 .ix synonym NOWHOPEN RMR_ERR_NOWHOPEN
119 .ix synonym WHID RMR_ERR_WHID
121 .ix synonym OVERFLOW RMR_ERR_OVERFLOW
123 .ix synonym RETRY RMR_ERR_RETRY
125 .ix synonym RCVFAILED RMR_ERR_RCVFAILED
127 .ix synonym TIMEOUT RMR_ERR_TIMEOUT
129 .ix synonym UNSET RMR_ERR_UNSET
131 .ix synonym TRUNC RMR_ERR_TRUNC
133 .ix synonym NOTSUPP RMR_ERR_NOTSUPP
137 .** ------------ groups ------------------------------------------------
138 .** order listed on the group is order displayed in the index under the group heading.
139 .** labels with no references in the doc are omitted, so safe to add all values
141 .ix group Functions rmr_call rmr_get_ip rmr_get_src rmr_init rmr_init_trace rmr_rcv_msg rmr_ready rmr_rts_msg rmr_send_msg rmr_wh_close rmr_wh_open rmr_wh_send_msg
143 .ix group `Env Variables` RMR_BIND_IF RMR_RTG_SVC RMR_RTG_ISRAW RMR_SEED_RT RMR_SRC_NAMEONLY RMR_VCTL_FILE
145 .ix group `Errors (RMR_ERR_*)` OK BADARG CALLFAILED EMPTY NOENDPT NOHDR NOTSUPP NOWHOPEN OVERFLOW SENDFAILED RETRY RCVFAILED TIMEOUT TRUNC UNSET WHID
147 .** .ix group Tables `end table` `start table` `table cell` `table row` `table header`