src/core/core.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file core/core.h
  23  * @brief common internal definitions for core service
  24  * @author Christian Grothoff
  25  */
  26 #ifndef CORE_H
  27 #define CORE_H
  28
  29 #include "gnunet_bandwidth_lib.h"
  30 #include "gnunet_transport_service.h"
  31 #include "gnunet_crypto_lib.h"
  32 #include "gnunet_time_lib.h"
  33
  34 /**
  35  * General core debugging.
  36  */
  37 #define DEBUG_CORE GNUNET_EXTRA_LOGGING
  38
  39 /**
  40  * Definition of bits in the InitMessage's options field that specify
  41  * which events this client cares about.  Note that inbound messages
  42  * for handlers that were specifically registered are always
  43  * transmitted to the client.
  44  */
  45 #define GNUNET_CORE_OPTION_NOTHING             0
  46 #define GNUNET_CORE_OPTION_SEND_STATUS_CHANGE  4
  47 #define GNUNET_CORE_OPTION_SEND_FULL_INBOUND   8
  48 #define GNUNET_CORE_OPTION_SEND_HDR_INBOUND   16
  49 #define GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND 32
  50 #define GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND  64
  51
  52
  53 GNUNET_NETWORK_STRUCT_BEGIN
  54
  55 /**
  56  * Message transmitted core clients to gnunet-service-core
  57  * to start the interaction.  This header is followed by
  58  * uint16_t type values specifying which messages this
  59  * client is interested in.
  60  */
  61 struct InitMessage
  62 {
  63
  64   /**
  65    * Header with type GNUNET_MESSAGE_TYPE_CORE_INIT.
  66    */
  67   struct GNUNET_MessageHeader header;
  68
  69   /**
  70    * Options, see GNUNET_CORE_OPTION_ values.
  71    */
  72   uint32_t options GNUNET_PACKED;
  73
  74 };
  75
  76
  77 /**
  78  * Message transmitted by the gnunet-service-core process
  79  * to its clients in response to an INIT message.
  80  */
  81 struct InitReplyMessage
  82 {
  83
  84   /**
  85    * Header with type GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY
  86    */
  87   struct GNUNET_MessageHeader header;
  88
  89   /**
  90    * Always zero.
  91    */
  92   uint32_t reserved GNUNET_PACKED;
  93
  94   /**
  95    * Public key of the local peer.
  96    */
  97   struct GNUNET_PeerIdentity my_identity;
  98
  99 };
 100
 101
 102 /**
 103  * Message sent by the service to clients to notify them
 104  * about a peer connecting.
 105  */
 106 struct ConnectNotifyMessage
 107 {
 108   /**
 109    * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT
 110    */
 111   struct GNUNET_MessageHeader header;
 112
 113   /**
 114    * Identity of the connecting peer.
 115    */
 116   struct GNUNET_PeerIdentity peer;
 117
 118 };
 119
 120
 121 /**
 122  * Message sent by the service to clients to notify them
 123  * about a peer disconnecting.
 124  */
 125 struct DisconnectNotifyMessage
 126 {
 127   /**
 128    * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT.
 129    */
 130   struct GNUNET_MessageHeader header;
 131
 132   /**
 133    * Always zero.
 134    */
 135   uint32_t reserved GNUNET_PACKED;
 136
 137   /**
 138    * Identity of the connecting peer.
 139    */
 140   struct GNUNET_PeerIdentity peer;
 141
 142 };
 143
 144
 145 /**
 146  * Message sent by the service to clients to notify them about
 147  * messages being received or transmitted.  This overall message is
 148  * followed by the real message, or just the header of the real
 149  * message (depending on the client's preferences).  The receiver can
 150  * tell if he got the full message or only a partial message by
 151  * looking at the size field in the header of NotifyTrafficMessage and
 152  * checking it with the size field in the message that follows.
 153  */
 154 struct NotifyTrafficMessage
 155 {
 156   /**
 157    * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND
 158    * or GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND.
 159    */
 160   struct GNUNET_MessageHeader header;
 161
 162   /**
 163    * Identity of the receiver or sender.
 164    */
 165   struct GNUNET_PeerIdentity peer;
 166
 167   /* Followed by payload (message or just header), variable size */
 168 };
 169
 170
 171 /**
 172  * Client notifying core about the maximum-priority
 173  * message it has in the queue for a particular target.
 174  */
 175 struct SendMessageRequest
 176 {
 177   /**
 178    * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST
 179    */
 180   struct GNUNET_MessageHeader header;
 181
 182   /**
 183    * How important is this message?
 184    */
 185   uint32_t priority GNUNET_PACKED;
 186
 187   /**
 188    * By what time would the sender really like to see this
 189    * message transmitted?
 190    */
 191   struct GNUNET_TIME_AbsoluteNBO deadline;
 192
 193   /**
 194    * Identity of the intended target.
 195    */
 196   struct GNUNET_PeerIdentity peer;
 197
 198   /**
 199    * Always zero.
 200    */
 201   uint32_t reserved GNUNET_PACKED;
 202
 203   /**
 204    * How large is the message?
 205    */
 206   uint16_t size GNUNET_PACKED;
 207
 208   /**
 209    * Counter for this peer to match SMRs to replies.
 210    */
 211   uint16_t smr_id GNUNET_PACKED;
 212
 213 };
 214
 215
 216 /**
 217  * Core notifying client that it is allowed to now
 218  * transmit a message to the given target
 219  * (response to GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST).
 220  */
 221 struct SendMessageReady
 222 {
 223   /**
 224    * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_READY
 225    */
 226   struct GNUNET_MessageHeader header;
 227
 228   /**
 229    * How many bytes are allowed for transmission?
 230    * Guaranteed to be at least as big as the requested size,
 231    * or ZERO if the request is rejected (will timeout,
 232    * peer disconnected, queue full, etc.).
 233    */
 234   uint16_t size GNUNET_PACKED;
 235
 236   /**
 237    * smr_id from the request.
 238    */
 239   uint16_t smr_id GNUNET_PACKED;
 240
 241   /**
 242    * Identity of the intended target.
 243    */
 244   struct GNUNET_PeerIdentity peer;
 245
 246 };
 247
 248
 249 /**
 250  * Client asking core to transmit a particular message to a particular
 251  * target (response to GNUNET_MESSAGE_TYPE_CORE_SEND_READY).
 252  */
 253 struct SendMessage
 254 {
 255   /**
 256    * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND
 257    */
 258   struct GNUNET_MessageHeader header;
 259
 260   /**
 261    * How important is this message?
 262    */
 263   uint32_t priority GNUNET_PACKED;
 264
 265   /**
 266    * By what time would the sender really like to see this
 267    * message transmitted?
 268    */
 269   struct GNUNET_TIME_AbsoluteNBO deadline;
 270
 271   /**
 272    * Identity of the intended receiver.
 273    */
 274   struct GNUNET_PeerIdentity peer;
 275
 276   /**
 277    * GNUNET_YES if corking is allowed, GNUNET_NO if not.
 278    */
 279   uint32_t cork GNUNET_PACKED;
 280
 281   /**
 282    * Always 0.
 283    */
 284   uint64_t reserved GNUNET_PACKED;
 285
 286 };
 287
 288
 289 GNUNET_NETWORK_STRUCT_END
 290 #endif
 291 /* end of core.h */