aboutsummaryrefslogtreecommitdiff
path: root/src/gns/gns.h
blob: 5950c460bd70378eaee2dd3b9635b9064351ca56 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
      This file is part of GNUnet
      (C) 2012 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
      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
      General Public License for more details.

      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
      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
 * @author Martin Schanzenbach
 */
#ifndef GNS_H
#define GNS_H

#define GNUNET_GNS_TLD "gnunet"
#define GNUNET_GNS_TLD_ZKEY "zkey"
#define GNUNET_GNS_DHT_MAX_UPDATE_INTERVAL 3600

#define MAX_DNS_LABEL_LENGTH 63
#define MAX_DNS_NAME_LENGTH 253

GNUNET_NETWORK_STRUCT_BEGIN

/**
 * Message from client to GNS service to lookup records.
 */
struct GNUNET_GNS_ClientLookupMessage
{
  /**
    * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
   */
  struct GNUNET_MessageHeader header;

  /**
   * Unique identifier for this request (for key collisions).
   */
  uint32_t id GNUNET_PACKED;

  /**
   * the type of record to look up
   */
  // FIXME: bad type - should be of GNUNET_GNS_RecordType
  enum GNUNET_GNS_RecordType type;

  /* 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
   */
  struct GNUNET_MessageHeader header;

  /**
   * Unique identifier for this request (for key collisions).
   */
  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*/

};

/**
 * Message from client to GNS service to shorten names.
 */
struct GNUNET_GNS_ClientShortenMessage
{
  /**
    * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN
   */
  struct GNUNET_MessageHeader header;

  /**
   * Unique identifier for this request
   */
  uint32_t id GNUNET_PACKED;

  /* Followed by the name to shorten up */
};


/**
 * Message from GNS service to client: shorten result.
 */
struct GNUNET_GNS_ClientShortenResultMessage
{
  /**
    * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN_RESULT
   */
  struct GNUNET_MessageHeader header;

  /**
   * Unique identifier for this request (for key collisions).
   */
  uint32_t id GNUNET_PACKED;

  /* followed by the shortened name or '\0' for no result*/

};

/**
 * Message from client to GNS service to lookup an authority of a name.
 */
struct GNUNET_GNS_ClientGetAuthMessage
{
  /**
    * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH
   */
  struct GNUNET_MessageHeader header;

  /**
   * Unique identifier for this request
   */
  uint32_t id GNUNET_PACKED;

  /* Followed by the name to get authority for */
};


/**
 * Message from GNS service to client: authority result.
 */
struct GNUNET_GNS_ClientGetAuthResultMessage
{
  /**
    * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH_RESULT
   */
  struct GNUNET_MessageHeader header;

  /**
   * Unique identifier for this request (for key collisions).
   */
  uint32_t id GNUNET_PACKED;

  /* followed by the authority part of the name or '\0' for no result*/

};
GNUNET_NETWORK_STRUCT_END

#endif