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