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_type:
  68 @payload_data:
  69 @Returns:
  70 <!-- # Unused Parameters # -->
  71 @msg:
  72
  73
  74 <!-- ##### FUNCTION gras_cb_register ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @msgtype:
  80 @cb:
  81 @Returns:
  82 <!-- # Unused Parameters # -->
  83 @message:
  84 @TTL:
  85
  86
  87 <!-- ##### FUNCTION gras_cb_unregister ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @msgtype:
  93 @cb:
  94
  95
  96 <!-- ##### FUNCTION gras_msg_send ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @sock:
 102 @msgtype:
 103 @payload:
 104 @Returns:
 105 <!-- # Unused Parameters # -->
 106 @sd:
 107 @msg:
 108 @freeDirective:
 109
 110
 111 <!-- ##### FUNCTION gras_msg_wait ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @timeout:
 117 @msgt_want:
 118 @expeditor:
 119 @payload:
 120 @Returns:
 121 <!-- # Unused Parameters # -->
 122 @id:
 123 @message:
 124
 125
 126 <!-- ##### FUNCTION gras_msg_handle ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @timeOut:
 132 @Returns:
 133
 134