aboutsummaryrefslogtreecommitdiff
path: root/src/dht/dht.h
blob: 6c2f4cbd8437a3c2ffc5867d1bf884eb698cb733 (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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
     This file is part of GNUnet.
     (C) 2001, 2002, 2003, 2004, 2009 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.
*/

/**
 * @author Christian Grothoff
 * @author Nathan Evans
 * @file dht/dht.h
 */

#ifndef DHT_H_
#define DHT_H_

#define DEBUG_DHT GNUNET_NO

typedef void (*GNUNET_DHT_MessageReceivedHandler) (void *cls,
                                                   struct GNUNET_MessageHeader
                                                   * msg);

/**
 * Generic DHT message, wrapper for other message types
 */
struct GNUNET_DHT_StopMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_DHT_MESSAGE
   */
  struct GNUNET_MessageHeader header;

  /**
   * Unique ID identifying this request
   */
  uint64_t unique_id;

};


/**
 * Generic DHT message, wrapper for other message types
 */
struct GNUNET_DHT_Message
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_DHT_MESSAGE
   */
  struct GNUNET_MessageHeader header;

  /**
   * The key to search for
   */
  GNUNET_HashCode key;

  /**
   * Replication level for this message
   */
  uint16_t desired_replication_level;

  /**
   * Message options
   */
  uint16_t options;

  /**
   * Is this message uniquely identified?  If so it will
   * be fire and forget, if not we will wait for a receipt
   * from the service.
   */
  uint16_t unique;


  /**
   * Unique ID identifying this request
   */
  uint64_t unique_id;

  /* */
  /* GNUNET_MessageHeader *enc actual DHT message, copied to end of this dealy do */

};

/**
 * Message to insert data into the DHT
 */
struct GNUNET_DHT_PutMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_DHT_PUT
   */
  struct GNUNET_MessageHeader header;

  /**
   * The type of data to insert.
   */
  size_t type;

  /**
   * The size of the data, appended to the end of this message.
   */
  size_t data_size;

  /**
   * How long should this data persist?
   */
  struct GNUNET_TIME_Absolute expiration;

};


/**
 * Message to request data from the DHT
 */
struct GNUNET_DHT_GetMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_DHT_GET
   */
  struct GNUNET_MessageHeader header;

  /**
   * The type for the data for the GET request
   */
  size_t type;

};

/**
 * Message to return data from the DHT
 */
struct GNUNET_DHT_GetResultMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_DHT_GET_RESULT
   */
  struct GNUNET_MessageHeader header;

  /**
   * The type for the data for the GET request
   */
  size_t type;

  /**
   * The key to search for
   */
  GNUNET_HashCode key;

  /**
   * When does this entry expire?
   */
  struct GNUNET_TIME_Absolute expiration;

  /**
   * The size of the data, appended to the end of this message.
   */
  size_t data_size;

};

/**
 * Message to issue find peer request to the DHT
 */
struct GNUNET_DHT_FindPeerMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_DHT_FIND_PEER
   */
  struct GNUNET_MessageHeader header;

  /**
   * Size of inject message (may be zero)
   */
  size_t msg_len;

  /* Followed by message to inject at found peers */

};

/**
 * Message to return data from the DHT
 */
struct GNUNET_DHT_FindPeerResultMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_DHT_FIND_PEER_RESULT
   */
  struct GNUNET_MessageHeader header;

  /**
   * The peer that was found
   */
  struct GNUNET_PeerIdentity peer;

  /**
   * The size of the return message from the peer
   * (defaults to HELLO for the peer),
   * appended to the end of this message, 0 if
   * no message.
   */
  size_t data_size;

};

#endif /* DHT_H_ */