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