doc/src/library/index_snatch.im

   1 .if false
   2 ==================================================================================
   3         Copyright (c) 2019 Nokia
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   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
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  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 ==================================================================================
  18 .fi
  19
  20 .if false
  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).
  24         Date:           31 July 2019
  25         Author:         E. Scott Daniels
  26 .fi
  27
  28
  29 .if pfm
  30 .** ensure that index collection is going
  31 .ix resume
  32
  33 .ix snare context
  34 .ix synonym context ctx
  35
  36 .ix snare endpoint
  37
  38 .ix snare `message type`
  39 .ix synonym `message type` MT/SID
  40 .ix synonym `message type` `message type,`
  41
  42 .ix snare nanomsg
  43 .ix synonym nanomsg Nanomsg
  44 .ix snare NNG
  45 .ix snare payload
  46
  47 .ix snare `round robin`
  48 .ix synonym `round robin` round-robin
  49 .ix snare `route table`
  50
  51 .ix snare `standard error`
  52 .ix synonym `standard error` stderr
  53 .ix snare `standard out`
  54 .ix synonym `standard out` stdout
  55
  56 .ix snare `subscription ID`
  57 .ix synonym `subscription ID` `subscription ID,`
  58 .ix synonym `subscription ID` `subID`
  59
  60 .ix snare `transaction ID`
  61 .ix snare `trace data`
  62
  63 .ix snare boo
  64
  65 .** ----  functions --------
  66 .ix snare rmr_call
  67 .ix snare rmr_init
  68 .ix snare rmr_get_ip
  69 .ix snare rmr_get_src
  70 .ix snare rmr_ready
  71 .ix snare rmr_rcv_msg
  72 .ix snare rmr_rts_msg
  73 .ix snare rmr_send_msg
  74 .ix snare rmr_init_trace
  75 .ix snare rmr_wh_open
  76 .ix snare rmr_wh_close
  77 .ix snare rmr_wh_send_msg
  78
  79 .** ----- environment variables -----
  80 .ix snare RMR_BIND_IF
  81 .ix snare RMR_RTG_SVC
  82 .ix snare RMR_SEED_RT
  83 .ix snare RMR_RTG_ISRAW
  84 .ix snare RMR_VCTL_FILE
  85 .ix snare RMR_SRC_NAMEONLY
  86 .ix snare RMR_RTREQ_FREQ
  87 .ix snare RMR_CTL_PORT
  88
  89
  90 .** ----- errors -------------------
  91 .if false
  92 .ix snare RMR_OK
  93 .ix snare RMR_ERR_BADARG
  94 .ix snare RMR_ERR_NOENDPT
  95 .ix snare RMR_ERR_EMPTY
  96 .ix snare RMR_ERR_NOHDR
  97 .ix snare RMR_ERR_SENDFAILED
  98 .ix snare RMR_ERR_CALLFAILED
  99 .ix snare RMR_ERR_NOWHOPEN
 100 .ix snare RMR_ERR_WHID
 101 .ix snare RMR_ERR_OVERFLOW
 102 .ix snare RMR_ERR_RETRY
 103 .ix snare RMR_ERR_RCVFAILED
 104 .ix snare RMR_ERR_TIMEOUT
 105 .ix snare RMR_ERR_UNSET
 106 .ix snare RMR_ERR_TRUNC
 107 .ix snare RMR_ERR_NOTSUPP
 108 .fi
 109
 110 .ix snare OK
 111 .ix synonym OK RMR_OK
 112 .ix snare BADARG
 113 .ix synonym BADARG RMR_ERR_BADARG
 114 .ix snare NOENDPT
 115 .ix synonym NOENDPT RMR_ERR_NOENDPT
 116 .ix snare EMPTY
 117 .ix synonym EMPTY RMR_ERR_EMPTY
 118 .ix snare NOHDR
 119 .ix synonym NOHDR RMR_ERR_NOHDR
 120 .ix snare SENDFAILED
 121 .ix synonym SENDFAILED RMR_ERR_SENDFAILED
 122 .ix snare CALLFAILED
 123 .ix synonym CALLFAILED RMR_ERR_CALLFAILED
 124 .ix snare NOWHOPEN
 125 .ix synonym NOWHOPEN RMR_ERR_NOWHOPEN
 126 .ix snare WHID
 127 .ix synonym WHID RMR_ERR_WHID
 128 .ix snare OVERFLOW
 129 .ix synonym OVERFLOW RMR_ERR_OVERFLOW
 130 .ix snare RETRY
 131 .ix synonym RETRY RMR_ERR_RETRY
 132 .ix snare RCVFAILED
 133 .ix synonym RCVFAILED RMR_ERR_RCVFAILED
 134 .ix snare TIMEOUT
 135 .ix synonym TIMEOUT RMR_ERR_TIMEOUT
 136 .ix snare UNSET
 137 .ix synonym UNSET RMR_ERR_UNSET
 138 .ix snare TRUNC
 139 .ix synonym TRUNC RMR_ERR_TRUNC
 140 .ix snare NOTSUPP
 141 .ix synonym NOTSUPP RMR_ERR_NOTSUPP
 142
 143
 144
 145 .** ------------ groups ------------------------------------------------
 146 .** order listed on the group is order displayed in the index under the group heading.
 147 .** labels with no references in the doc are omitted, so safe to add all values
 148
 149 .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
 150
 151 .ix group `Env Variables` RMR_BIND_IF RMR_CTL_PORT RMR_RTREQ_FREQ RMR_RTG_SVC RMR_RTG_ISRAW RMR_SEED_RT RMR_SRC_NAMEONLY RMR_VCTL_FILE
 152
 153 .ix group `Errors (RMR_ERR_*)` OK BADARG CALLFAILED EMPTY NOENDPT NOHDR NOTSUPP NOWHOPEN OVERFLOW SENDFAILED RETRY RCVFAILED TIMEOUT TRUNC UNSET WHID
 154
 155 .** .ix group Tables `end table` `start table` `table cell` `table row` `table header`
 156 .fi
 157
 158