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