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  * Message from client to GNS service to lookup records.
  33  */
  34 struct GNUNET_GNS_ClientLookupMessage
  35 {
  36   /**
  37     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
  38    */
  39   struct GNUNET_MessageHeader header;
  40
  41   /**
  42    * A key. TODO some uid
  43    */
  44   GNUNET_HashCode key;
  45
  46   /**
  47    * Unique identifier for this request (for key collisions).
  48    */
  49   // FIXME: unaligned
  50   uint64_t unique_id;
  51
  52   /**
  53    * the type of record to look up
  54    */
  55   // FIXME: bad type - should be of GNUNET_GNS_RecordType
  56   int type;
  57
  58   /* Followed by the name to look up */
  59 };
  60
  61
  62 /**
  63  * Message from GNS service to client: new results.
  64  */
  65 struct GNUNET_GNS_ClientResultMessage
  66 {
  67   /**
  68     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
  69    */
  70   struct GNUNET_MessageHeader header;
  71
  72   /**
  73    * Unique identifier for this request (for key collisions).
  74    */
  75   // FIXME: unaligned
  76   uint64_t unique_id;
  77
  78   /**
  79    * A key. TODO some uid
  80    * // FIXME: why hash?
  81    */
  82   GNUNET_HashCode key;
  83
  84   /**
  85    * The number of records contained in response
  86    */
  87   uint32_t num_records;
  88
  89   // FIXME: what format has a GNS_Record?
  90   /* followed by num_records GNUNET_GNS_Records*/
  91
  92 };
  93
  94
  95 GNUNET_NETWORK_STRUCT_END
  96
  97 #endif