cruft/doc/tmpl/comm_messages.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Messages
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Defining messages and callbacks, and sending/receiving messages.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### FUNCTION gras_msgtype_declare ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @name:
  23 @payload:
  24 @Returns:
  25 <!-- # Unused Parameters # -->
  26 @dst:
  27
  28
  29 <!-- ##### FUNCTION gras_msgtype_declare_v ##### -->
  30 <para>
  31
  32 </para>
  33
  34 @name:
  35 @version:
  36 @payload:
  37 @Returns:
  38 <!-- # Unused Parameters # -->
  39 @dst:
  40
  41
  42 <!-- ##### FUNCTION gras_msgtype_by_name ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @name:
  48 @Returns:
  49 <!-- # Unused Parameters # -->
  50 @dst:
  51
  52
  53 <!-- ##### FUNCTION gras_msgtype_by_namev ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @name:
  59 @version:
  60 @Returns:
  61 <!-- # Unused Parameters # -->
  62 @dst:
  63
  64
  65 <!-- ##### USER_FUNCTION gras_cb_t ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @expeditor:
  71 @payload:
  72 @Returns:
  73 <!-- # Unused Parameters # -->
  74 @payload_type:
  75 @payload_data:
  76 @msg:
  77
  78
  79 <!-- ##### FUNCTION gras_cb_register ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @msgtype:
  85 @cb:
  86 @Returns:
  87 <!-- # Unused Parameters # -->
  88 @message:
  89 @TTL:
  90
  91
  92 <!-- ##### FUNCTION gras_cb_unregister ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @msgtype:
  98 @cb:
  99
 100
 101 <!-- ##### FUNCTION gras_msg_send ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @sock:
 107 @msgtype:
 108 @payload:
 109 @Returns:
 110 <!-- # Unused Parameters # -->
 111 @sd:
 112 @msg:
 113 @freeDirective:
 114
 115
 116 <!-- ##### FUNCTION gras_msg_wait ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @timeout:
 122 @msgt_want:
 123 @expeditor:
 124 @payload:
 125 @Returns:
 126 <!-- # Unused Parameters # -->
 127 @id:
 128 @message:
 129
 130
 131 <!-- ##### FUNCTION gras_msg_handle ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @timeOut:
 137 @Returns:
 138
 139