use enum GNUNET_ATS_Network_Type instead of uint32_t where appropriate

[oweals/gnunet.git] / src / include / gnunet_mq_lib.h

diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h
index fd28f3de654e521ac7140230bd6c0fa3555695c5..26330f3ee62b835d883507829529d450c2d1ee1c 100644 (file)
--- a/src/include/gnunet_mq_lib.h
+++ b/src/include/gnunet_mq_lib.h
@@ -143,22 +143,22 @@ struct GNUNET_MQ_Envelope;
 
 /**
  * Error codes for the queue.
- */ 
+ */
 enum GNUNET_MQ_Error
 {
   /**
    * FIXME: document!
-   */ 
+   */
   GNUNET_MQ_ERROR_READ = 1,
 
   /**
    * FIXME: document!
-   */ 
+   */
   GNUNET_MQ_ERROR_WRITE = 2,
 
   /**
    * FIXME: document!
-   */ 
+   */
   GNUNET_MQ_ERROR_TIMEOUT = 4
 };
 
@@ -193,7 +193,7 @@ typedef void
  * destruction of a message queue.
  * Implementations must not free @a mq, but should
  * take care of @a impl_state.
- * 
+ *
  * @param mq the message queue to destroy
  * @param impl_state state of the implementation
  */
@@ -203,7 +203,7 @@ typedef void
 
 /**
  * Implementation function that cancels the currently sent message.
- * 
+ *
  * @param mq message queue
  * @param impl_state state specific to the implementation
  */
@@ -239,7 +239,7 @@ typedef void
 struct GNUNET_MQ_MessageHandler
 {
   /**
-   * Callback, called every time a new message of 
+   * Callback, called every time a new message of
    * the specified type has been receied.
    */
   GNUNET_MQ_MessageCallback cb;
@@ -262,7 +262,7 @@ struct GNUNET_MQ_MessageHandler
 
 /**
  * Create a new envelope.
- * 
+ *
  * @param mhp message header to store the allocated message header in, can be NULL
  * @param size size of the message to allocate
  * @param type type of the message, will be set in the allocated message
@@ -286,12 +286,12 @@ GNUNET_MQ_discard (struct GNUNET_MQ_Envelope *mqm);
 /**
  * Send a message with the give message queue.
  * May only be called once per message.
- * 
+ *
  * @param mq message queue
  * @param ev the envelope with the message to send.
  */
 void
-GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq, 
+GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq,
                struct GNUNET_MQ_Envelope *ev);
 
 
@@ -385,13 +385,13 @@ GNUNET_MQ_queue_for_callbacks (GNUNET_MQ_SendImpl send,
                                const struct GNUNET_MQ_MessageHandler *handlers,
                                GNUNET_MQ_ErrorHandler error_handler,
                                void *cls);
-                               
+
 
 
 /**
- * Replace the handlers of a message queue with new handlers.
- * Takes effect immediately, even for messages that already have been received, but for
- * with the handler has not been called.
+ * Replace the handlers of a message queue with new handlers.  Takes
+ * effect immediately, even for messages that already have been
+ * received, but for with the handler has not been called.
  *
  * If the message queue does not support receiving messages,
  * this function has no effect.
@@ -474,11 +474,14 @@ GNUNET_MQ_impl_send_continue (struct GNUNET_MQ_Handle *mq);
 
 /**
  * Get the message that should currently be sent.
+ * The returned message is only valid until #GNUNET_MQ_impl_send_continue
+ * is called.
  * Fails if there is no current message.
  * Only useful for implementing message queues,
  * results in undefined behavior if not used carefully.
  *
- * @param mq message queue with the current message
+ * @param mq message queue with the current message, only valid
+ *        until #GNUNET_MQ_impl_send_continue is called
  * @return message to send, never NULL
  */
 const struct GNUNET_MessageHeader *
@@ -503,16 +506,6 @@ void *
 GNUNET_MQ_impl_state (struct GNUNET_MQ_Handle *mq);
 
 
-/**
- * Mark the current message as irrevocably sent, but do not
- * proceed with sending the next message.
- * Will call the appropriate GNUNET_MQ_NotifyCallback, if any.
- *
- * @param mq message queue
- */
-void
-GNUNET_MQ_impl_send_commit (struct GNUNET_MQ_Handle *mq);
-
 /** @} */ /* end of group mq */
 
 #endif