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 `subscription ID`
  52 .ix synonym `subscription ID` `subscription ID,`
  53 .ix synonym `subscription ID` `subID`
  54
  55 .ix snare `transaction ID`
  56 .ix snare `trace data`
  57
  58 .ix snare boo
  59
  60 .** ----  functions --------
  61 .ix snare rmr_call
  62 .ix snare rmr_init
  63 .ix snare rmr_get_ip
  64 .ix snare rmr_get_src
  65 .ix snare rmr_ready
  66 .ix snare rmr_rcv_msg
  67 .ix snare rmr_rts_msg
  68 .ix snare rmr_send_msg
  69 .ix snare rmr_init_trace
  70 .ix snare rmr_wh_open
  71 .ix snare rmr_wh_close
  72 .ix snare rmr_wh_send_msg
  73
  74 .** ----- environment variables -----
  75 .ix snare RMR_BIND_IF
  76 .ix snare RMR_RTG_SVC
  77 .ix snare RMR_SEED_RT
  78 .ix snare RMR_RTG_ISRAW
  79 .ix snare RMR_VCTL_FILE
  80 .ix snare RMR_SRC_NAMEONLY
  81 .ix snare RMR_RTREQ_FREQ
  82 .ix snare RMR_CTL_PORT
  83
  84
  85 .** ----- errors -------------------
  86 .if false
  87 .ix snare RMR_OK
  88 .ix snare RMR_ERR_BADARG
  89 .ix snare RMR_ERR_NOENDPT
  90 .ix snare RMR_ERR_EMPTY
  91 .ix snare RMR_ERR_NOHDR
  92 .ix snare RMR_ERR_SENDFAILED
  93 .ix snare RMR_ERR_CALLFAILED
  94 .ix snare RMR_ERR_NOWHOPEN
  95 .ix snare RMR_ERR_WHID
  96 .ix snare RMR_ERR_OVERFLOW
  97 .ix snare RMR_ERR_RETRY
  98 .ix snare RMR_ERR_RCVFAILED
  99 .ix snare RMR_ERR_TIMEOUT
 100 .ix snare RMR_ERR_UNSET
 101 .ix snare RMR_ERR_TRUNC
 102 .ix snare RMR_ERR_NOTSUPP
 103 .fi
 104
 105 .ix snare OK
 106 .ix synonym OK RMR_OK
 107 .ix snare BADARG
 108 .ix synonym BADARG RMR_ERR_BADARG
 109 .ix snare NOENDPT
 110 .ix synonym NOENDPT RMR_ERR_NOENDPT
 111 .ix snare EMPTY
 112 .ix synonym EMPTY RMR_ERR_EMPTY
 113 .ix snare NOHDR
 114 .ix synonym NOHDR RMR_ERR_NOHDR
 115 .ix snare SENDFAILED
 116 .ix synonym SENDFAILED RMR_ERR_SENDFAILED
 117 .ix snare CALLFAILED
 118 .ix synonym CALLFAILED RMR_ERR_CALLFAILED
 119 .ix snare NOWHOPEN
 120 .ix synonym NOWHOPEN RMR_ERR_NOWHOPEN
 121 .ix snare WHID
 122 .ix synonym WHID RMR_ERR_WHID
 123 .ix snare OVERFLOW
 124 .ix synonym OVERFLOW RMR_ERR_OVERFLOW
 125 .ix snare RETRY
 126 .ix synonym RETRY RMR_ERR_RETRY
 127 .ix snare RCVFAILED
 128 .ix synonym RCVFAILED RMR_ERR_RCVFAILED
 129 .ix snare TIMEOUT
 130 .ix synonym TIMEOUT RMR_ERR_TIMEOUT
 131 .ix snare UNSET
 132 .ix synonym UNSET RMR_ERR_UNSET
 133 .ix snare TRUNC
 134 .ix synonym TRUNC RMR_ERR_TRUNC
 135 .ix snare NOTSUPP
 136 .ix synonym NOTSUPP RMR_ERR_NOTSUPP
 137
 138
 139
 140 .** ------------ groups ------------------------------------------------
 141 .** order listed on the group is order displayed in the index under the group heading.
 142 .** labels with no references in the doc are omitted, so safe to add all values
 143
 144 .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
 145
 146 .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
 147
 148 .ix group `Errors (RMR_ERR_*)` OK BADARG CALLFAILED EMPTY NOENDPT NOHDR NOTSUPP NOWHOPEN OVERFLOW SENDFAILED RETRY RCVFAILED TIMEOUT TRUNC UNSET WHID
 149
 150 .** .ix group Tables `end table` `start table` `table cell` `table row` `table header`
 151 .fi
 152
 153