- fix encryption/decryption visisbility

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

diff --git a/src/include/gnunet_mesh_service.h b/src/include/gnunet_mesh_service.h
index f1a9be35eb18b5fcbcf8bfe4b540ea788a5c205d..fa63826836c80c16e6c56b024fa97745d0be6b2d 100644 (file)
--- a/src/include/gnunet_mesh_service.h
+++ b/src/include/gnunet_mesh_service.h
@@ -95,7 +95,7 @@ enum MeshTunnelOption
 /**
  * Functions with this signature are called whenever a message is
  * received.
- * 
+ *
  * Each time the function must call #GNUNET_MESH_receive_done on the tunnel
  * in order to receive the next message. This doesn't need to be immediate:
  * can be delayed if some processing is done on the message.
@@ -104,7 +104,7 @@ enum MeshTunnelOption
  * @param tunnel Connection to the other end.
  * @param tunnel_ctx Place to store local state associated with the tunnel.
  * @param message The actual message.
- * 
+ *
  * @return #GNUNET_OK to keep the tunnel open,
  *         #GNUNET_SYSERR to close it (signal serious error).
  */
@@ -155,9 +155,7 @@ struct GNUNET_MESH_MessageHandler
  *         (can be NULL -- that's not an error)
  */
 typedef void *(GNUNET_MESH_InboundTunnelNotificationHandler) (void *cls,
-                                                              struct
-                                                              GNUNET_MESH_Tunnel
-                                                              * tunnel,
+                                                              struct GNUNET_MESH_Tunnel *tunnel,
                                                               const struct
                                                               GNUNET_PeerIdentity
                                                               * initiator,
@@ -166,8 +164,8 @@ typedef void *(GNUNET_MESH_InboundTunnelNotificationHandler) (void *cls,
 
 /**
  * Function called whenever a tunnel is destroyed.  Should clean up
- * any associated state. 
- * 
+ * any associated state.
+ *
  * It must NOT call #GNUNET_MESH_tunnel_destroy on the tunnel.
  *
  * @param cls closure (set from #GNUNET_MESH_connect)
@@ -184,26 +182,27 @@ typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls,
  * Connect to the mesh service.
  *
  * @param cfg Configuration to use.
- * @param cls Closure for the various callbacks that follow (including 
+ * @param cls Closure for the various callbacks that follow (including
  *            handlers in the handlers array).
  * @param new_tunnel Function called when an *incoming* tunnel is created.
  *                   Can be NULL if no inbound tunnels are desired.
  *                   See @c ports.
  * @param cleaner Function called when a tunnel is destroyed by the remote peer.
- *                It is NOT called if GNUNET_MESH_tunnel_destroy is called on
+ *                It is NOT called if #GNUNET_MESH_tunnel_destroy is called on
  *                the tunnel.
  * @param handlers Callbacks for messages we care about, NULL-terminated. Each
  *                 one must call #GNUNET_MESH_receive_done on the tunnel to
  *                 receive the next message.  Messages of a type that is not
- *                 in the handlers array are ignored if received. 
+ *                 in the handlers array are ignored if received.
  * @param ports NULL or 0-terminated array of port numbers for incoming tunnels.
  *              See @c new_tunnel.
- * 
+ *
  * @return handle to the mesh service NULL on error
  *         (in this case, init is never called)
  */
 struct GNUNET_MESH_Handle *
-GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
+GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                    void *cls,
                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
                      GNUNET_MESH_TunnelEndHandler cleaner,
                      const struct GNUNET_MESH_MessageHandler *handlers,
@@ -235,7 +234,7 @@ GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
  * @return handle to the tunnel
  */
 struct GNUNET_MESH_Tunnel *
-GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, 
+GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
                            void *tunnel_ctx,
                            const struct GNUNET_PeerIdentity *peer,
                            uint32_t port,
@@ -245,7 +244,7 @@ GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
 
 /**
  * Destroy an existing tunnel.
- * 
+ *
  * The existing end callback for the tunnel will be called immediately.
  * Any pending outgoing messages will be sent but no incoming messages will be
  * accepted and no data callbacks will be called.
@@ -259,17 +258,18 @@ GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel);
 /**
  * Struct to retrieve info about a tunnel.
  */
-union MeshTunnelInfo {
+union GNUNET_MESH_TunnelInfo
+{
 
   /**
-   * GNUNET_YES / GNUNET_NO, for binary flags.
+   * #GNUNET_YES / #GNUNET_NO, for binary flags.
    */
   int yes_no;
 
   /**
    * Peer on the other side of the tunnel
    */
-  struct GNUNET_PeerIdentity *peer;
+  const struct GNUNET_PeerIdentity peer;
 };
 
 
@@ -282,7 +282,7 @@ union MeshTunnelInfo {
  *
  * @return Union with an answer to the query.
  */
-const union MeshTunnelInfo *
+const union GNUNET_MESH_TunnelInfo *
 GNUNET_MESH_tunnel_get_info (struct GNUNET_MESH_Tunnel *tunnel,
                              enum MeshTunnelOption option, ...);
 
@@ -332,7 +332,7 @@ GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
 
 /**
  * Indicate readiness to receive the next message on a tunnel.
- * 
+ *
  * Should only be called once per handler called.
  *
  * @param tunnel Tunnel that will be allowed to call another handler.
@@ -438,8 +438,8 @@ GNUNET_MESH_get_tunnels_cancel (struct GNUNET_MESH_Handle *h);
  * The message queue can only be used to transmit messages,
  * not to receive them.
  *
- * @param tunnel the tunnel to create the message qeue for
- * @return a message queue to messages over the tunnel
+ * @param tunnel the tunnel to create the message queue for
+ * @return a message queue for sending messages over the tunnel
  */
 struct GNUNET_MQ_Handle *
 GNUNET_MESH_mq_create (struct GNUNET_MESH_Tunnel *tunnel);