migrate secretsharing to new service API
[oweals/gnunet.git] / src / nat-auto / nat-auto.h
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2011, 2016, 2017 GNUnet e.V.
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      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      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, USA.
19 */
20
21 /**
22  * @file src/nat-auto/nat-auto.h
23  * @brief Messages for interaction with gnunet-nat-auto-service
24  * @author Christian Grothoff
25  *
26  */
27 #ifndef NAT_AUTO_H
28 #define NAT_AUTO_H
29 #include "gnunet_util_lib.h"
30
31
32
33 GNUNET_NETWORK_STRUCT_BEGIN
34
35 /**
36  * Request to test NAT traversal, sent to the gnunet-nat-server
37  * (not the service!).
38  */
39 struct GNUNET_NAT_AUTO_TestMessage
40 {
41   /**
42    * Header with type #GNUNET_MESSAGE_TYPE_NAT_TEST
43    */
44   struct GNUNET_MessageHeader header;
45
46   /**
47    * IPv4 target IP address
48    */
49   uint32_t dst_ipv4;
50
51   /**
52    * Port to use, 0 to send dummy ICMP response.
53    */
54   uint16_t dport;
55
56   /**
57    * Data to send OR advertised-port (in NBO) to use for dummy ICMP.
58    */
59   uint16_t data;
60
61   /**
62    * #GNUNET_YES for TCP, #GNUNET_NO for UDP.
63    */
64   int32_t is_tcp;
65
66 };
67
68
69 /**
70  * Client requesting automatic configuration.
71  */
72 struct GNUNET_NAT_AUTO_AutoconfigRequestMessage
73 {
74   /**
75    * Header with type #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG
76    */
77   struct GNUNET_MessageHeader header;
78
79   /* Followed by configuration (diff, serialized, compressed) */
80   
81 };
82
83
84 /**
85  * Service responding with proposed configuration.
86  */
87 struct GNUNET_NAT_AUTO_AutoconfigResultMessage
88 {
89   /**
90    * Header with type #GNUNET_MESSAGE_TYPE_NAT_AUTO_CFG_RESULT
91    */
92   struct GNUNET_MessageHeader header;
93   
94   /**
95    * An `enum GNUNET_NAT_StatusCode` in NBO.
96    */
97   int32_t status_code GNUNET_PACKED;
98
99   /**
100    * An `enum GNUNET_NAT_Type` in NBO.
101    */
102   int32_t type GNUNET_PACKED;
103
104   /* Followed by configuration (diff, serialized, compressed) */
105 };
106
107
108 GNUNET_NETWORK_STRUCT_END
109
110 #endif