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_register ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @msgId:
  23 @name:
  24 @sequence_count:
  25 @Varargs:
  26 @Returns:
  27
  28
  29 <!-- ##### USER_FUNCTION gras_cb_t ##### -->
  30 <para>
  31
  32 </para>
  33
  34 @msg:
  35 @Returns:
  36
  37
  38 <!-- ##### FUNCTION gras_cb_register ##### -->
  39 <para>
  40
  41 </para>
  42
  43 @message:
  44 @TTL:
  45 @cb:
  46 @Returns:
  47
  48
  49 <!-- ##### FUNCTION gras_msg_new ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @msgId:
  55 @free_data_on_free:
  56 @seqCount:
  57 @Varargs:
  58 @Returns:
  59
  60
  61 <!-- ##### FUNCTION gras_msg_free ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @msg:
  67
  68
  69 <!-- ##### FUNCTION gras_msg_handle ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @timeOut:
  75 @Returns:
  76
  77
  78 <!-- ##### FUNCTION gras_msg_send ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @sd:
  84 @msg:
  85 @freeDirective:
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION gras_msg_wait ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @timeout:
  95 @id:
  96 @message:
  97 @Returns:
  98
  99