/*
This file is part of GNUnet.
- (C) 2009, 2010 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009-2014 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
* @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"
/**
* General core debugging.
*/
-#define DEBUG_CORE GNUNET_NO
-
-/**
- * Debugging interaction core-clients.
- */
-#define DEBUG_CORE_CLIENT GNUNET_NO
+#define DEBUG_CORE GNUNET_EXTRA_LOGGING
/**
* Definition of bits in the InitMessage's options field that specify
* transmitted to the client.
*/
#define GNUNET_CORE_OPTION_NOTHING 0
-#define GNUNET_CORE_OPTION_SEND_CONNECT 1
-#define GNUNET_CORE_OPTION_SEND_DISCONNECT 2
+
+/**
+ * Client cares about connectivity changes.
+ */
#define GNUNET_CORE_OPTION_SEND_STATUS_CHANGE 4
+
+/**
+ * Client wants all inbound messages in full.
+ */
#define GNUNET_CORE_OPTION_SEND_FULL_INBOUND 8
+
+/**
+ * Client just wants the 4-byte message headers of
+ * all inbound messages.
+ */
#define GNUNET_CORE_OPTION_SEND_HDR_INBOUND 16
+
+/**
+ * Client wants all outbound messages in full.
+ */
#define GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND 32
+
+/**
+ * Client just wants the 4-byte message headers of
+ * all outbound messages.
+ */
#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
{
/**
- * Header with type GNUNET_MESSAGE_TYPE_CORE_INIT.
+ * Header with type #GNUNET_MESSAGE_TYPE_CORE_INIT.
*/
struct GNUNET_MessageHeader header;
{
/**
- * Header with type GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY
+ * Header with type #GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY
*/
struct GNUNET_MessageHeader header;
/**
* Public key of the local peer.
*/
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded publicKey;
+ struct GNUNET_PeerIdentity my_identity;
};
struct ConnectNotifyMessage
{
/**
- * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT
+ * Header with type #GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT
*/
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;
-
};
struct DisconnectNotifyMessage
{
/**
- * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT.
+ * Header with type #GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT.
*/
struct GNUNET_MessageHeader header;
struct NotifyTrafficMessage
{
/**
- * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND
- * or GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND.
+ * Header with type #GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND
+ * or #GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND.
*/
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;
-
- /**
- * Limit the number of bytes of outbound traffic to this
- * peer to at most the specified amount (naturally, the
- * amount is also limited by the receiving peer).
- */
- struct GNUNET_BANDWIDTH_Value32NBO limit_outbound;
-
- /**
- * 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;
-
- /**
- * 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 */
};
struct SendMessageRequest
{
/**
- * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST
+ * Header with type #GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST
*/
struct GNUNET_MessageHeader header;
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?
/**
- * Core notifying client that it is allowed to now
+ * 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;
/**
- * How many bytes are allowed for transmission?
+ * How many bytes are allowed for transmission?
* Guaranteed to be at least as big as the requested size,
- * or ZERO if the request is rejected (will timeout,
+ * or ZERO if the request is rejected (will timeout,
* peer disconnected, queue full, etc.).
*/
uint16_t size GNUNET_PACKED;
/**
* Client asking core to transmit a particular message to a particular
- * target (responsde 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;
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;
/**
* Always 0.
*/
- uint64_t reserved GNUNET_PACKED;
+ uint32_t reserved GNUNET_PACKED;
};
/**
- * 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).
+ * Message sent by the service to monitor clients to notify them
+ * about a peer changing status.
*/
-struct ConnectMessage
+struct MonitorNotifyMessage
{
/**
- * Header with type GNUNET_MESSAGE_TYPE_REQUEST_CONNECT or
- * GNUNET_MESSAGE_TYPE_REQUEST_DISCONNECT.
+ * Header with type #GNUNET_MESSAGE_TYPE_CORE_MONITOR_NOTIFY
*/
struct GNUNET_MessageHeader header;
/**
- * For alignment.
+ * New peer state, an `enum GNUNET_CORE_KxState` in NBO.
*/
- uint32_t reserved GNUNET_PACKED;
+ uint32_t state GNUNET_PACKED;
/**
- * When to time out.
+ * Identity of the peer.
*/
- struct GNUNET_TIME_RelativeNBO timeout;
+ struct GNUNET_PeerIdentity peer;
/**
- * Identity of the other peer.
+ * How long will we stay in this state (if nothing else happens)?
*/
- struct GNUNET_PeerIdentity peer;
+ struct GNUNET_TIME_AbsoluteNBO timeout;
};
+
+GNUNET_NETWORK_STRUCT_END
+#endif
/* end of core.h */
projects / oweals / gnunet.git / blobdiff