src/gns/gns.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2012 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 2, 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 #include "gnunet_gns_service.h"
  22
  23 /**
  24  * @file gns/gns.h
  25  * @brief IPC messages between GNS API and GNS service
  26  * @author Martin Schanzenbach
  27  */
  28 #ifndef GNS_H
  29 #define GNS_H
  30
  31 #define GNUNET_GNS_TLD "gnunet"
  32 #define GNUNET_GNS_TLD_ZKEY "zkey"
  33 #define GNUNET_GNS_DHT_MAX_UPDATE_INTERVAL 3600
  34
  35 #define MAX_DNS_LABEL_LENGTH 63
  36 #define MAX_DNS_NAME_LENGTH 253
  37
  38 GNUNET_NETWORK_STRUCT_BEGIN
  39
  40 /**
  41  * Message from client to GNS service to lookup records.
  42  */
  43 struct GNUNET_GNS_ClientLookupMessage
  44 {
  45   /**
  46     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
  47    */
  48   struct GNUNET_MessageHeader header;
  49
  50   /**
  51    * Unique identifier for this request (for key collisions).
  52    */
  53   uint32_t id GNUNET_PACKED;
  54
  55   /**
  56    * Should we look up in the default zone?
  57    */
  58   uint32_t use_default_zone GNUNET_PACKED;
  59
  60   /**
  61    * If use_default_zone is empty this zone is used for lookup
  62    */
  63   struct GNUNET_CRYPTO_ShortHashCode zone;
  64
  65   /**
  66    * the type of record to look up
  67    */
  68   enum GNUNET_GNS_RecordType type;
  69
  70   /* Followed by the name to look up */
  71 };
  72
  73
  74 /**
  75  * Message from GNS service to client: new results.
  76  */
  77 struct GNUNET_GNS_ClientLookupResultMessage
  78 {
  79   /**
  80     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
  81    */
  82   struct GNUNET_MessageHeader header;
  83
  84   /**
  85    * Unique identifier for this request (for key collisions).
  86    */
  87   uint32_t id GNUNET_PACKED;
  88
  89   /**
  90    * The number of records contained in response
  91    */
  92   uint32_t rd_count;
  93
  94   // FIXME: what format has a GNS_Record?
  95   /* followed by rd_count GNUNET_NAMESTORE_RecordData structs*/
  96
  97 };
  98
  99 /**
 100  * Message from client to GNS service to shorten names.
 101  */
 102 struct GNUNET_GNS_ClientShortenMessage
 103 {
 104   /**
 105     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN
 106    */
 107   struct GNUNET_MessageHeader header;
 108
 109   /**
 110    * Unique identifier for this request
 111    */
 112   uint32_t id GNUNET_PACKED;
 113
 114   /**
 115    * Should we look up in the default zone?
 116    */
 117   uint32_t use_default_zone GNUNET_PACKED;
 118
 119   /**
 120    * If use_default_zone is empty this zone is used for lookup
 121    */
 122   struct GNUNET_CRYPTO_ShortHashCode zone;
 123
 124   /* Followed by the name to shorten up */
 125 };
 126
 127
 128 /**
 129  * Message from GNS service to client: shorten result.
 130  */
 131 struct GNUNET_GNS_ClientShortenResultMessage
 132 {
 133   /**
 134     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN_RESULT
 135    */
 136   struct GNUNET_MessageHeader header;
 137
 138   /**
 139    * Unique identifier for this request (for key collisions).
 140    */
 141   uint32_t id GNUNET_PACKED;
 142
 143   /* followed by the shortened name or '\0' for no result*/
 144
 145 };
 146
 147 /**
 148  * Message from client to GNS service to lookup an authority of a name.
 149  */
 150 struct GNUNET_GNS_ClientGetAuthMessage
 151 {
 152   /**
 153     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH
 154    */
 155   struct GNUNET_MessageHeader header;
 156
 157   /**
 158    * Unique identifier for this request
 159    */
 160   uint32_t id GNUNET_PACKED;
 161
 162   /* Followed by the name to get authority for */
 163 };
 164
 165
 166 /**
 167  * Message from GNS service to client: authority result.
 168  */
 169 struct GNUNET_GNS_ClientGetAuthResultMessage
 170 {
 171   /**
 172     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH_RESULT
 173    */
 174   struct GNUNET_MessageHeader header;
 175
 176   /**
 177    * Unique identifier for this request (for key collisions).
 178    */
 179   uint32_t id GNUNET_PACKED;
 180
 181   /* followed by the authority part of the name or '\0' for no result*/
 182
 183 };
 184 GNUNET_NETWORK_STRUCT_END
 185
 186 #endif