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   uint64_t unique_id;
  46
  47   /**
  48    * the type of record to look up
  49    */
  50   int type;
  51
  52   /**
  53    * Length of name to lookup
  54    */
  55   uint32_t namelen;
  56
  57   /* Followed by the name to look up */
  58 };
  59
  60
  61 /**
  62  * Message from GNS service to client: new results.
  63  */
  64 struct GNUNET_GNS_ClientResultMessage
  65 {
  66   /**
  67     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
  68    */
  69   struct GNUNET_MessageHeader header;
  70
  71   /**
  72    * Unique identifier for this request (for key collisions).
  73    */
  74   uint64_t unique_id;
  75
  76   /**
  77    * A key. TODO some uid
  78    */
  79   GNUNET_HashCode key;
  80
  81   /**
  82    * The number of records contained in response
  83    */
  84   uint32_t num_records;
  85
  86   /* followed by num_records GNUNET_GNS_Records*/
  87
  88 };
  89
  90
  91 GNUNET_NETWORK_STRUCT_END
  92
  93 #endif