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_DHT_MAX_UPDATE_INTERVAL 3600
  33
  34 GNUNET_NETWORK_STRUCT_BEGIN
  35
  36 /**
  37  * Message from client to GNS service to lookup records.
  38  */
  39 struct GNUNET_GNS_ClientLookupMessage
  40 {
  41   /**
  42     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
  43    */
  44   struct GNUNET_MessageHeader header;
  45
  46   /**
  47    * Unique identifier for this request (for key collisions).
  48    */
  49   uint32_t id GNUNET_PACKED;
  50
  51   /**
  52    * the type of record to look up
  53    */
  54   // FIXME: bad type - should be of GNUNET_GNS_RecordType
  55   enum GNUNET_GNS_RecordType type;
  56
  57   /* Followed by the name to look up */
  58 };
  59
  60
  61 /**
  62  * Message from GNS service to client: new results.
  63  */
  64 struct GNUNET_GNS_ClientLookupResultMessage
  65 {
  66   /**
  67     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
  68    */
  69   struct GNUNET_MessageHeader header;
  70
  71   /**
  72    * Unique identifier for this request (for key collisions).
  73    */
  74   uint32_t id GNUNET_PACKED;
  75
  76   /**
  77    * The number of records contained in response
  78    */
  79   uint32_t rd_count;
  80
  81   // FIXME: what format has a GNS_Record?
  82   /* followed by rd_count GNUNET_NAMESTORE_RecordData structs*/
  83
  84 };
  85
  86 /**
  87  * Message from client to GNS service to shorten names.
  88  */
  89 struct GNUNET_GNS_ClientShortenMessage
  90 {
  91   /**
  92     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN
  93    */
  94   struct GNUNET_MessageHeader header;
  95
  96   /**
  97    * Unique identifier for this request
  98    */
  99   uint32_t id GNUNET_PACKED;
 100
 101   /* Followed by the name to shorten up */
 102 };
 103
 104
 105 /**
 106  * Message from GNS service to client: shorten result.
 107  */
 108 struct GNUNET_GNS_ClientShortenResultMessage
 109 {
 110   /**
 111     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN_RESULT
 112    */
 113   struct GNUNET_MessageHeader header;
 114
 115   /**
 116    * Unique identifier for this request (for key collisions).
 117    */
 118   uint32_t id GNUNET_PACKED;
 119
 120   /* followed by the shortened name or '\0' for no result*/
 121
 122 };
 123
 124 /**
 125  * Message from client to GNS service to lookup an authority of a name.
 126  */
 127 struct GNUNET_GNS_ClientGetAuthMessage
 128 {
 129   /**
 130     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH
 131    */
 132   struct GNUNET_MessageHeader header;
 133
 134   /**
 135    * Unique identifier for this request
 136    */
 137   uint32_t id GNUNET_PACKED;
 138
 139   /* Followed by the name to get authority for */
 140 };
 141
 142
 143 /**
 144  * Message from GNS service to client: authority result.
 145  */
 146 struct GNUNET_GNS_ClientGetAuthResultMessage
 147 {
 148   /**
 149     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH_RESULT
 150    */
 151   struct GNUNET_MessageHeader header;
 152
 153   /**
 154    * Unique identifier for this request (for key collisions).
 155    */
 156   uint32_t id GNUNET_PACKED;
 157
 158   /* followed by the authority part of the name or '\0' for no result*/
 159
 160 };
 161 GNUNET_NETWORK_STRUCT_END
 162
 163 #endif