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 /**
  22  * @file gns/gns.h
  23  * @brief IPC messages between GNS API and GNS service
  24  * @author Martin Schanzenbach
  25  */
  26 #ifndef GNS_H
  27 #define GNS_H
  28
  29 GNUNET_NETWORK_STRUCT_BEGIN
  30
  31 /**
  32  * Equivalent to GNUNET_DNSPARSER_Record
  33  * FIXME typedef?
  34  */
  35 struct GNUNET_GNS_Record
  36 {
  37   //struct GNUNET_DNSPARSER_Record record;
  38
  39   //enum GNUNET_NAMESTORE_RecordFlags flags;
  40
  41   const struct GNUNET_NAMESTORE_SignatureLocation *sig_loc;
  42
  43 };
  44 /**
  45  * Message from client to GNS service to lookup records.
  46  */
  47 struct GNUNET_GNS_ClientLookupMessage
  48 {
  49   /**
  50     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
  51    */
  52   struct GNUNET_MessageHeader header;
  53
  54   /**
  55    * A key. TODO some uid
  56    */
  57   GNUNET_HashCode key;
  58
  59   /**
  60    * Unique identifier for this request (for key collisions).
  61    */
  62   // FIXME: unaligned
  63   uint64_t unique_id;
  64
  65   /**
  66    * the type of record to look up
  67    */
  68   // FIXME: bad type - should be of GNUNET_GNS_RecordType
  69   int type;
  70
  71   /* Followed by the name to look up */
  72 };
  73
  74
  75 /**
  76  * Message from GNS service to client: new results.
  77  */
  78 struct GNUNET_GNS_ClientResultMessage
  79 {
  80   /**
  81     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
  82    */
  83   struct GNUNET_MessageHeader header;
  84
  85   /**
  86    * Unique identifier for this request (for key collisions).
  87    */
  88   // FIXME: unaligned
  89   uint64_t unique_id;
  90
  91   /**
  92    * A key. TODO some uid
  93    * // FIXME: why hash?
  94    */
  95   GNUNET_HashCode key;
  96
  97   /**
  98    * The number of records contained in response
  99    */
 100   uint32_t num_records;
 101
 102   // FIXME: what format has a GNS_Record?
 103   /* followed by num_records GNUNET_GNS_Records*/
 104
 105 };
 106
 107
 108 GNUNET_NETWORK_STRUCT_END
 109
 110 #endif