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 @dst:
  49 @Returns:
  50
  51
  52 <!-- ##### FUNCTION gras_msgtype_by_namev ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @name:
  58 @version:
  59 @dst:
  60 @Returns:
  61
  62
  63 <!-- ##### USER_FUNCTION gras_cb_t ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @expeditor:
  69 @payload:
  70 @Returns:
  71 <!-- # Unused Parameters # -->
  72 @payload_type:
  73 @payload_data:
  74 @msg:
  75
  76
  77 <!-- ##### FUNCTION gras_cb_register ##### -->
  78 <para>
  79
  80 </para>
  81
  82 @msgtype:
  83 @cb:
  84 @Returns:
  85 <!-- # Unused Parameters # -->
  86 @message:
  87 @TTL:
  88
  89
  90 <!-- ##### FUNCTION gras_cb_unregister ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @msgtype:
  96 @cb:
  97
  98
  99 <!-- ##### FUNCTION gras_msg_send ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @sock:
 105 @msgtype:
 106 @payload:
 107 @Returns:
 108 <!-- # Unused Parameters # -->
 109 @sd:
 110 @msg:
 111 @freeDirective:
 112
 113
 114 <!-- ##### FUNCTION gras_msg_wait ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @timeout:
 120 @msgt_want:
 121 @expeditor:
 122 @payload:
 123 @Returns:
 124 <!-- # Unused Parameters # -->
 125 @id:
 126 @message:
 127
 128
 129 <!-- ##### FUNCTION gras_msg_handle ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @timeOut:
 135 @Returns:
 136
 137