cruft/doc/tmpl/gras.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 gras
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### ENUM DataTypes ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @CHAR_TYPE:
  23 @DOUBLE_TYPE:
  24 @FLOAT_TYPE:
  25 @INT_TYPE:
  26 @LONG_TYPE:
  27 @SHORT_TYPE:
  28 @UNSIGNED_INT_TYPE:
  29 @UNSIGNED_LONG_TYPE:
  30 @UNSIGNED_SHORT_TYPE:
  31 @STRUCT_TYPE:
  32 @LAST_TYPE:
  33
  34 <!-- ##### MACRO SIMPLE_DATA ##### -->
  35 <para>
  36
  37 </para>
  38
  39 @type:
  40 @repetitions:
  41
  42
  43 <!-- ##### MACRO SIMPLE_MEMBER ##### -->
  44 <para>
  45
  46 </para>
  47
  48 @type:
  49 @repetitions:
  50 @offset:
  51
  52
  53 <!-- ##### MACRO PAD_BYTES ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @structType:
  59 @lastMember:
  60 @memberType:
  61 @repetitions:
  62
  63
  64 <!-- ##### MACRO EODD ##### -->
  65 <para>
  66
  67 </para>
  68
  69
  70
  71 <!-- ##### FUNCTION grasOpenClientSocket ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @host:
  77 @Param2:
  78 @sock:
  79 @Returns:
  80
  81
  82 <!-- ##### FUNCTION grasOpenServerSocket ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @Param1:
  88 @Param2:
  89 @sock:
  90 @Returns:
  91
  92
  93 <!-- ##### FUNCTION grasCloseSocket ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @sock:
  99 @Returns:
 100
 101
 102 <!-- ##### FUNCTION grasPeerGetName ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @sd:
 108 @Returns:
 109
 110
 111 <!-- ##### FUNCTION grasPeerGetAddress ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @sd:
 117 @Returns:
 118
 119
 120 <!-- ##### FUNCTION grasMyMachineName ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @Returns:
 126
 127
 128 <!-- ##### TYPEDEF grasMessageType_t ##### -->
 129 <para>
 130
 131 </para>
 132
 133
 134 <!-- ##### FUNCTION grasMsgRegister ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @message:
 140 @name:
 141 @sequence_count:
 142 @Varargs:
 143 @Returns:
 144
 145
 146 <!-- ##### USER_FUNCTION grasCallbackFunction ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @sd:
 152 @msgType:
 153 @vdata:
 154
 155
 156 <!-- ##### FUNCTION grasRegisterCallback ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @message:
 162 @TTL:
 163 @cb:
 164
 165
 166 <!-- ##### FUNCTION grasMsgHandle ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @timeOut:
 172
 173
 174 <!-- ##### FUNCTION grasMsgSend ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @sd:
 180 @message:
 181 @sequence_count:
 182 @Varargs:
 183 @Returns:
 184
 185
 186 <!-- ##### FUNCTION grasMsgWait ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @sd:
 192 @timeout:
 193 @message:
 194 @sequence_count:
 195 @Varargs:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION grasUserdataGet ##### -->
 200 <para>
 201
 202 </para>
 203
 204
 205
 206 <!-- ##### FUNCTION grasUserdataSet ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @ud:
 212
 213
 214 <!-- ##### MACRO grasUserdataNew ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @type:
 220
 221