-code hygene

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

diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h
index ea8391d4e01fd527e6367fabd0090442bb53c0a5..4eca0cc03994779b6f60fb8e175d328f4c3762e3 100644 (file)
--- a/src/include/gnunet_core_service.h
+++ b/src/include/gnunet_core_service.h
@@ -127,12 +127,9 @@ struct GNUNET_CORE_MessageHandler
  * do this later).
  *
  * @param cls closure
- * @param server handle to the server, NULL if we failed;
- *        TODO: consider removing this argument, it is redundant...
  * @param my_identity ID of this peer, NULL if we failed
  */
 typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
-                                             struct GNUNET_CORE_Handle * server,
                                              const struct GNUNET_PeerIdentity *my_identity);
 
 
@@ -158,7 +155,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  *                messages if the client does not process them fast enough (for this
  *                notification type, a bounded queue is used)
  * @param inbound_hdr_only set to #GNUNET_YES if @a inbound_notify will only read the
- *                GNUNET_MessageHeader and hence we do not need to give it the full message;
+ *                `struct GNUNET_MessageHeader` and hence we do not need to give it the full message;
  *                can be used to improve efficiency, ignored if inbound_notify is NULL
  *                note that the core is allowed to drop notifications about inbound
  *                messages if the client does not process them fast enough (for this
@@ -168,7 +165,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  *                messages if the client does not process them fast enough (for this
  *                notification type, a bounded queue is used)
  * @param outbound_hdr_only set to #GNUNET_YES if @a outbound_notify will only read the
- *                GNUNET_MessageHeader and hence we do not need to give it the full message
+ *                `struct GNUNET_MessageHeader` and hence we do not need to give it the full message
  *                can be used to improve efficiency, ignored if outbound_notify is NULL
  *                note that the core is allowed to drop notifications about outbound
  *                messages if the client does not process them fast enough (for this
@@ -283,11 +280,8 @@ GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
  * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are
  * expected to track which peers are connected based on the connect/disconnect
  * callbacks from #GNUNET_CORE_connect.  This function is NOT part of the
- * 'versioned', 'official' API. The difference between this function and the
- * function #GNUNET_CORE_is_peer_connected is that this one returns
- * synchronously after looking in the CORE API cache. The function
- * #GNUNET_CORE_is_peer_connected sends a message to the CORE service and hence
- * its response is given asynchronously.
+ * 'versioned', 'official' API.  This function returns
+ * synchronously after looking in the CORE API cache.
  *
  * @param h the core handle
  * @param pid the identity of the peer to check if it has been connected to us
@@ -298,6 +292,24 @@ GNUNET_CORE_is_peer_connected_sync (const struct GNUNET_CORE_Handle *h,
                                     const struct GNUNET_PeerIdentity *pid);
 
 
+/**
+ * Create a message queue for sending messages to a peer with CORE.
+ * Messages may only be queued with #GNUNET_MQ_send once the init callback has
+ * been called for the given handle.
+ * There must only be one queue per peer for each core handle.
+ * The message queue can only be used to transmit messages,
+ * not to receive them.
+ *
+ * @param h the core handle
+ * @param target the target peer for this queue, may not be NULL
+ * @return a message queue for sending messages over the core handle
+ *         to the target peer
+ */
+struct GNUNET_MQ_Handle *
+GNUNET_CORE_mq_create (struct GNUNET_CORE_Handle *h,
+                       const struct GNUNET_PeerIdentity *target);
+
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif