/*
This file is part of GNUnet
- (C) 2012 Christian Grothoff (and other contributing authors)
+ (C) 2012-2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
-
-#include "gnunet_gns_service.h"
-
/**
* @file gns/gns.h
* @brief IPC messages between GNS API and GNS service
#ifndef GNS_H
#define GNS_H
+#include "gnunet_gns_service.h"
+
+/**
+ * Name of the GNS TLD.
+ */
+#define GNUNET_GNS_TLD "gnu"
+
+/**
+ * Name of the zone key TLD.
+ */
+#define GNUNET_GNS_TLD_ZKEY "zkey"
+
+/**
+ * TLD name used to indicate relative names.
+ */
+#define GNUNET_GNS_TLD_PLUS "+"
+
+
GNUNET_NETWORK_STRUCT_BEGIN
/**
struct GNUNET_GNS_ClientLookupMessage
{
/**
- * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
+ * Header of type #GNUNET_MESSAGE_TYPE_GNS_LOOKUP
*/
struct GNUNET_MessageHeader header;
uint32_t id GNUNET_PACKED;
/**
- * the type of record to look up
+ * Zone that is to be used for lookup
*/
- // FIXME: bad type - should be of GNUNET_GNS_RecordType
- enum GNUNET_GNS_RecordType type;
+ struct GNUNET_CRYPTO_EccPublicSignKey zone;
- /* Followed by the name to look up */
-};
-
-
-/**
- * Message from GNS service to client: new results.
- */
-struct GNUNET_GNS_ClientLookupResultMessage
-{
/**
- * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
+ * Only check cached results
*/
- struct GNUNET_MessageHeader header;
+ int16_t only_cached GNUNET_PACKED;
/**
- * Unique identifier for this request (for key collisions).
+ * Is a shorten key attached?
*/
- uint32_t id GNUNET_PACKED;
-
- /**
- * The number of records contained in response
- */
- uint32_t rd_count;
-
- // FIXME: what format has a GNS_Record?
- /* followed by rd_count GNUNET_NAMESTORE_RecordData structs*/
+ int16_t have_key GNUNET_PACKED;
-};
-
-/**
- * Message from client to GNS service to lookup records.
- */
-struct GNUNET_GNS_ClientShortenMessage
-{
/**
- * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN
+ * the type of record to look up
*/
- struct GNUNET_MessageHeader header;
-
+ int32_t type GNUNET_PACKED;
+
/**
- * Unique identifier for this request
+ * The key for shorten, if @e have_key is set
*/
- uint32_t id GNUNET_PACKED;
+ struct GNUNET_CRYPTO_EccPrivateKey shorten_key;
- /* Followed by the name to shorten up */
+ /* Followed by the name to look up */
};
/**
- * Message from GNS service to client: shorten result.
+ * Message from GNS service to client: new results.
*/
-struct GNUNET_GNS_ClientShortenResultMessage
+struct GNUNET_GNS_ClientLookupResultMessage
{
/**
- * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN_RESULT
+ * Header of type #GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT
*/
struct GNUNET_MessageHeader header;
*/
uint32_t id GNUNET_PACKED;
- /* followed by the shortened name or '\0' for no result*/
+ /**
+ * The number of records contained in response
+ */
+ uint32_t rd_count GNUNET_PACKED;
+
+ /* followed by rd_count GNUNET_NAMESTORE_RecordData structs*/
};
+
+
GNUNET_NETWORK_STRUCT_END
#endif