-style fix
[oweals/gnunet.git] / src / core / core.h
index f57d2b59782cf00c0de562912245064bf35cc2cc..17014d6eca1a03b93e07da28cec32cef125430bc 100644 (file)
  * @brief common internal definitions for core service
  * @author Christian Grothoff
  */
+#ifndef CORE_H
+#define CORE_H
+
 #include "gnunet_bandwidth_lib.h"
+#include "gnunet_transport_service.h"
 #include "gnunet_crypto_lib.h"
 #include "gnunet_time_lib.h"
 
  */
 #define DEBUG_CORE GNUNET_EXTRA_LOGGING
 
-/**
- * Debugging interaction core-clients.
- */
-#define DEBUG_CORE_CLIENT GNUNET_EXTRA_LOGGING
-
 /**
  * Definition of bits in the InitMessage's options field that specify
  * which events this client cares about.  Note that inbound messages
@@ -44,8 +43,6 @@
  * transmitted to the client.
  */
 #define GNUNET_CORE_OPTION_NOTHING             0
-#define GNUNET_CORE_OPTION_SEND_CONNECT        1
-#define GNUNET_CORE_OPTION_SEND_DISCONNECT     2
 #define GNUNET_CORE_OPTION_SEND_STATUS_CHANGE  4
 #define GNUNET_CORE_OPTION_SEND_FULL_INBOUND   8
 #define GNUNET_CORE_OPTION_SEND_HDR_INBOUND   16
@@ -53,6 +50,8 @@
 #define GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND  64
 
 
+GNUNET_NETWORK_STRUCT_BEGIN
+
 /**
  * Message transmitted core clients to gnunet-service-core
  * to start the interaction.  This header is followed by
@@ -112,68 +111,15 @@ struct ConnectNotifyMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Number of ATS key-value pairs that follow this struct
-   * (excluding the 0-terminator).
+   * Always zero.
    */
-  uint32_t ats_count GNUNET_PACKED;
+  uint32_t reserved GNUNET_PACKED;
 
   /**
    * Identity of the connecting peer.
    */
   struct GNUNET_PeerIdentity peer;
 
-  /**
-   * First of the ATS information blocks (we must have at least
-   * one due to the 0-termination requirement).
-   */
-  struct GNUNET_TRANSPORT_ATS_Information ats;
-
-};
-
-
-/**
- * Message sent by the service to clients to notify them
- * about a peer changing status.
- */
-struct PeerStatusNotifyMessage
-{
-  /**
-   * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_PEER_STATUS
-   */
-  struct GNUNET_MessageHeader header;
-
-  /**
-   * Number of ATS key-value pairs that follow this struct
-   * (excluding the 0-terminator).
-   */
-  uint32_t ats_count GNUNET_PACKED;
-
-  /**
-   * When the peer would time out (unless we see activity)
-   */
-  struct GNUNET_TIME_AbsoluteNBO timeout;
-
-  /**
-   * Available bandwidth from the peer.
-   */
-  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
-
-  /**
-   * Available bandwidth to the peer.
-   */
-  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
-
-  /**
-   * Identity of the peer.
-   */
-  struct GNUNET_PeerIdentity peer;
-
-  /**
-   * First of the ATS information blocks (we must have at least
-   * one due to the 0-termination requirement).
-   */
-  struct GNUNET_TRANSPORT_ATS_Information ats;
-
 };
 
 
@@ -218,115 +164,12 @@ struct NotifyTrafficMessage
    */
   struct GNUNET_MessageHeader header;
 
-  /**
-   * Number of ATS key-value pairs that follow this struct
-   * (excluding the 0-terminator).
-   */
-  uint32_t ats_count GNUNET_PACKED;
-
   /**
    * Identity of the receiver or sender.
    */
   struct GNUNET_PeerIdentity peer;
 
-  /**
-   * First of the ATS information blocks (we must have at least
-   * one due to the 0-termination requirement).
-   */
-  struct GNUNET_TRANSPORT_ATS_Information ats;
-
-};
-
-
-/**
- * Message sent to the core asking for configuration
- * information and possibly preference changes.
- */
-struct RequestInfoMessage
-{
-  /**
-   * Header with type GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONFIGURE
-   */
-  struct GNUNET_MessageHeader header;
-
-  /**
-   * Unique request ID.
-   */
-  uint32_t rim_id GNUNET_PACKED;
-
-  /**
-   * Reserved, always zero.
-   */
-  uint32_t reserved GNUNET_PACKED;
-
-  /**
-   * Number of bytes of inbound traffic to reserve, can
-   * be negative (to unreserve).  NBO.
-   */
-  int32_t reserve_inbound GNUNET_PACKED;
-
-  /**
-   * Increment the current traffic preference for the given peer by
-   * the specified amont.  The traffic preference is used to determine
-   * the share of bandwidth this peer will typcially be assigned.
-   */
-  uint64_t preference_change GNUNET_PACKED;
-
-  /**
-   * Identity of the peer being configured.
-   */
-  struct GNUNET_PeerIdentity peer;
-
-};
-
-
-/**
- * Response from the core to a "RequestInfoMessage"
- * providing traffic status information for a peer.
- */
-struct ConfigurationInfoMessage
-{
-  /**
-   * Header with type GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO
-   */
-  struct GNUNET_MessageHeader header;
-
-  /**
-   * Amount of traffic (inbound number of bytes) that was reserved in
-   * response to the configuration change request.  Negative for
-   * "unreserved" bytes.
-   */
-  int32_t reserved_amount GNUNET_PACKED;
-
-  /**
-   * If the reservation request could not be satisfied (reserved_amount
-   * was zero), how long should the client wait until retrying? 0 if
-   * bandwidth was reserved.
-   */
-  struct GNUNET_TIME_RelativeNBO reserve_delay;
-
-  /**
-   * Unique request ID.
-   */
-  uint32_t rim_id GNUNET_PACKED;
-
-  /**
-   * Available bandwidth out for this peer,
-   * 0 if we have been disconnected.
-   */
-  struct GNUNET_BANDWIDTH_Value32NBO bw_out;
-
-  /**
-   * Current traffic preference for the peer.
-   * 0 if we have been disconnected.
-   */
-  uint64_t preference;
-
-  /**
-   * Identity of the peer.
-   */
-  struct GNUNET_PeerIdentity peer;
-
+  /* Followed by payload (message or just header), variable size */
 };
 
 
@@ -337,7 +180,7 @@ struct ConfigurationInfoMessage
 struct SendMessageRequest
 {
   /**
-   * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST
+   * Header with type #GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST
    */
   struct GNUNET_MessageHeader header;
 
@@ -358,9 +201,9 @@ struct SendMessageRequest
   struct GNUNET_PeerIdentity peer;
 
   /**
-   * How large is the client's message queue for this peer?
+   * Always zero.
    */
-  uint32_t queue_size GNUNET_PACKED;
+  uint32_t reserved GNUNET_PACKED;
 
   /**
    * How large is the message?
@@ -378,12 +221,12 @@ struct SendMessageRequest
 /**
  * Core notifying client that it is allowed to now
  * transmit a message to the given target
- * (response to GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST).
+ * (response to #GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST).
  */
 struct SendMessageReady
 {
   /**
-   * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_READY
+   * Header with type #GNUNET_MESSAGE_TYPE_CORE_SEND_READY
    */
   struct GNUNET_MessageHeader header;
 
@@ -410,12 +253,12 @@ struct SendMessageReady
 
 /**
  * Client asking core to transmit a particular message to a particular
- * target (response to GNUNET_MESSAGE_TYPE_CORE_SEND_READY).
+ * target (response to #GNUNET_MESSAGE_TYPE_CORE_SEND_READY).
  */
 struct SendMessage
 {
   /**
-   * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND
+   * Header with type #GNUNET_MESSAGE_TYPE_CORE_SEND
    */
   struct GNUNET_MessageHeader header;
 
@@ -431,12 +274,12 @@ struct SendMessage
   struct GNUNET_TIME_AbsoluteNBO deadline;
 
   /**
-   * Identity of the receiver or sender.
+   * Identity of the intended receiver.
    */
   struct GNUNET_PeerIdentity peer;
 
   /**
-   * GNUNET_YES if corking is allowed, GNUNET_NO if not.
+   * #GNUNET_YES if corking is allowed, #GNUNET_NO if not.
    */
   uint32_t cork GNUNET_PACKED;
 
@@ -448,31 +291,6 @@ struct SendMessage
 };
 
 
-/**
- * Client asking core to connect to a particular target.  There is no
- * response from the core to this type of request (however, if an
- * actual connection is created or destroyed, be it because of this
- * type request or not, the core generally needs to notify the
- * clients).
- */
-struct ConnectMessage
-{
-  /**
-   * Header with type GNUNET_MESSAGE_TYPE_REQUEST_CONNECT or
-   * GNUNET_MESSAGE_TYPE_REQUEST_DISCONNECT.
-   */
-  struct GNUNET_MessageHeader header;
-
-  /**
-   * For alignment.
-   */
-  uint32_t reserved GNUNET_PACKED;
-
-  /**
-   * Identity of the other peer.
-   */
-  struct GNUNET_PeerIdentity peer;
-
-};
-
+GNUNET_NETWORK_STRUCT_END
+#endif
 /* end of core.h */