src/gns/gns.h

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2012-2013 GNUnet e.V.
   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 3, 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., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, USA.
  19  */
  20 /**
  21  * @file gns/gns.h
  22  * @brief IPC messages between GNS API and GNS service
  23  * @author Martin Schanzenbach
  24  */
  25 #ifndef GNS_H
  26 #define GNS_H
  27
  28 #include "gnunet_gns_service.h"
  29
  30 /**
  31  * Name of the GNS TLD.
  32  */
  33 #define GNUNET_GNS_TLD "gnu"
  34
  35 /**
  36  * Name of the zone key TLD.
  37  */
  38 #define GNUNET_GNS_TLD_ZKEY "zkey"
  39
  40 /**
  41  * TLD name used to indicate relative names.
  42  */
  43 #define GNUNET_GNS_TLD_PLUS "+"
  44
  45
  46 GNUNET_NETWORK_STRUCT_BEGIN
  47
  48 /**
  49  * Message from client to GNS service to lookup records.
  50  */
  51 struct LookupMessage
  52 {
  53   /**
  54    * Header of type #GNUNET_MESSAGE_TYPE_GNS_LOOKUP
  55    */
  56   struct GNUNET_MessageHeader header;
  57
  58   /**
  59    * Unique identifier for this request (for key collisions).
  60    */
  61   uint32_t id GNUNET_PACKED;
  62
  63   /**
  64    * Zone that is to be used for lookup
  65    */
  66   struct GNUNET_CRYPTO_EcdsaPublicKey zone;
  67
  68   /**
  69    * Local options for where to look for results
  70    * (an `enum GNUNET_GNS_LocalOptions` in NBO).
  71    */
  72   int16_t options GNUNET_PACKED;
  73
  74   /**
  75    * Always 0.
  76    */
  77   int16_t reserved GNUNET_PACKED;
  78
  79   /**
  80    * the type of record to look up
  81    */
  82   int32_t type GNUNET_PACKED;
  83
  84   /* Followed by the zero-terminated name to look up */
  85 };
  86
  87
  88 /**
  89  * Message from GNS service to client: new results.
  90  */
  91 struct LookupResultMessage
  92 {
  93   /**
  94     * Header of type #GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT
  95    */
  96   struct GNUNET_MessageHeader header;
  97
  98   /**
  99    * Unique identifier for this request (for key collisions).
 100    */
 101   uint32_t id GNUNET_PACKED;
 102
 103   /**
 104    * The number of records contained in response
 105    */
 106   uint32_t rd_count GNUNET_PACKED;
 107
 108   /* followed by rd_count GNUNET_GNSRECORD_Data structs*/
 109
 110 };
 111
 112
 113 GNUNET_NETWORK_STRUCT_END
 114
 115 #endif