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