Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / util / resolver.h
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2009, 2012 GNUnet e.V.
4
5      GNUnet is free software: you can redistribute it and/or modify it
6      under the terms of the GNU Affero General Public License as published
7      by the Free Software Foundation, either version 3 of the License,
8      or (at your 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      Affero General Public License for more details.
14     
15      You should have received a copy of the GNU Affero General Public License
16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 /**
20  * @author Christian Grothoff
21  * @file util/resolver.h
22  */
23 #ifndef RESOLVER_H
24 #define RESOLVER_H
25
26 #include "gnunet_common.h"
27
28 GNUNET_NETWORK_STRUCT_BEGIN
29
30 /**
31  * Request for the resolver.  Followed by either the "struct sockaddr"
32  * or the 0-terminated hostname.
33  *
34  * The response will be one or more messages of type
35  * RESOLVER_RESPONSE, each with the message header immediately
36  * followed by the requested data (0-terminated hostname or struct
37  * in[6]_addr, depending on direction).  The last RESOLVER_RESPONSE
38  * will just be a header without any data (used to indicate the end of
39  * the list).
40  */
41 struct GNUNET_RESOLVER_GetMessage
42 {
43   /**
44    * Type:  #GNUNET_MESSAGE_TYPE_RESOLVER_REQUEST
45    */
46   struct GNUNET_MessageHeader header;
47
48   /**
49    * GNUNET_YES to get hostname from IP,
50    * GNUNET_NO to get IP from hostname.
51    */
52   int32_t direction GNUNET_PACKED;
53
54   /**
55    * Address family to use (AF_INET, AF_INET6 or AF_UNSPEC).
56    */
57   int32_t af GNUNET_PACKED;
58
59   /**
60    * identifies the request and is contained in the response message. The
61    * client has to match response to request by this identifier.
62    */
63   uint32_t client_id GNUNET_PACKED;
64
65   /* followed by 0-terminated string for A/AAAA-lookup or
66      by 'struct in_addr' / 'struct in6_addr' for reverse lookup */
67
68 };
69
70
71 struct GNUNET_RESOLVER_ResponseMessage
72 {
73   /**
74    * Type: #GNUNET_MESSAGE_TYPE_RESOLVER_RESPONSE
75    */
76   struct GNUNET_MessageHeader header;
77
78   /**
79    * identifies the request this message responds to. The client
80    * has to match response to request by this identifier.
81    */
82   uint32_t client_id GNUNET_PACKED;
83
84   /* followed by 0-terminated string for response to a reverse lookup
85    * or by 'struct in_addr' / 'struct in6_addr' for response to
86    * A/AAAA-lookup
87    */
88 };
89
90 GNUNET_NETWORK_STRUCT_END
91
92 #endif