namestore.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2011-2013 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef NAMESTORE_H
#define NAMESTORE_H
 
#define MAX_NAME_LEN 256
 
GNUNET_NETWORK_STRUCT_BEGIN
 
struct GNUNET_NAMESTORE_Header
{
  struct GNUNET_MessageHeader header;
 
  uint32_t r_id GNUNET_PACKED;
};
 
struct RecordSet
{
  uint16_t name_len GNUNET_PACKED;
 
  uint16_t rd_len GNUNET_PACKED;
 
  uint16_t rd_count GNUNET_PACKED;
 
  uint16_t reserved GNUNET_PACKED;
 
 
  /* followed by:
   * name with length name_len
   * serialized record data with rd_count records
   */
};
 
struct RecordStoreMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t reserved;
 
  uint16_t single_tx GNUNET_PACKED;
 
  uint16_t rd_set_count;
 
  uint16_t key_len GNUNET_PACKED;
 
};
 
 
struct NamestoreResponseMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint32_t ec GNUNET_PACKED;
 
};
 
struct EditRecordSetResponseMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t editor_hint_len GNUNET_PACKED;
 
  uint16_t ec GNUNET_PACKED;
 
  uint16_t rd_len GNUNET_PACKED;
 
  uint16_t rd_count GNUNET_PACKED;
 
};
 
 
struct LabelLookupMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t label_len GNUNET_PACKED;
 
  uint16_t unused GNUNET_PACKED;
 
  uint16_t filter;
 
  uint16_t key_len GNUNET_PACKED;
 
  /* followed by:
   * the private zone key
   * name with length name_len
   */
};
 
struct EditRecordSetMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t label_len GNUNET_PACKED;
 
  uint16_t editor_hint_len GNUNET_PACKED;
 
  uint16_t reserved GNUNET_PACKED;
 
  uint16_t key_len GNUNET_PACKED;
 
  /* followed by:
   * the private zone key
   * label with length label_len
   * editor hint with length editor_hint_len
   */
};
 
 
struct EditRecordSetCancelMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t label_len GNUNET_PACKED;
 
  uint16_t editor_hint_len GNUNET_PACKED;
 
  uint16_t editor_hint_replacement_len GNUNET_PACKED;
 
  uint16_t key_len GNUNET_PACKED;
 
  /* followed by:
   * the private zone key
   * label with length label_len
   * editor hint with length editor_hint_len
   * replacement editor hint with length editor_hint_replacement_len
   */
};
 
 
struct LabelLookupResponseMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t name_len GNUNET_PACKED;
 
  uint16_t rd_len GNUNET_PACKED;
 
  uint16_t rd_count GNUNET_PACKED;
 
  int16_t found GNUNET_PACKED;
 
  uint16_t reserved GNUNET_PACKED;
 
  uint16_t key_len GNUNET_PACKED;
 
  /* followed by:
   * the private zone key
   * name with length name_len
   * serialized record data with rd_count records
   */
};
 
 
struct ZoneToNameMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t key_len GNUNET_PACKED;
 
  uint16_t pkey_len GNUNET_PACKED;
 
};
 
 
struct ZoneToNameResponseMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  int32_t ec GNUNET_PACKED;
 
  uint16_t name_len GNUNET_PACKED;
 
  uint16_t rd_len GNUNET_PACKED;
 
  uint16_t rd_count GNUNET_PACKED;
 
  uint16_t key_len GNUNET_PACKED;
 
  /* followed by:
   * the private zone key
   * name with length name_len
   * serialized record data with rd_count records
   */
};
 
 
struct RecordResultMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  struct GNUNET_TIME_AbsoluteNBO expire;
 
  uint16_t name_len GNUNET_PACKED;
 
  uint16_t rd_len GNUNET_PACKED;
 
  uint16_t rd_count GNUNET_PACKED;
 
  uint16_t key_len GNUNET_PACKED;
 
  /* followed by:
   * the private key of the authority
   * name with length name_len
   * serialized record data with rd_count records
   */
};
 
struct TxControlMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t reserved GNUNET_PACKED;
 
  uint16_t control GNUNET_PACKED;
 
};
 
struct TxControlResultMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint32_t ec GNUNET_PACKED;
 
};
 
 
 
struct ZoneMonitorStartMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t iterate_first GNUNET_PACKED;
 
  uint16_t filter;
 
  uint16_t key_len GNUNET_PACKED;
 
};
 
 
struct ZoneMonitorNextMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t reserved;
 
  uint64_t limit;
};
 
 
struct ZoneIterationStartMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint16_t filter;
 
  uint16_t key_len GNUNET_PACKED;
 
};
 
 
struct ZoneIterationNextMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
 
  uint64_t limit;
};
 
 
struct ZoneIterationStopMessage
{
  struct GNUNET_NAMESTORE_Header gns_header;
};
 
 
GNUNET_NETWORK_STRUCT_END
 
 
/* end of namestore.h */
#endif