2 This file is part of GNUnet.
3 Copyright (C) 2007-2017 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Christian Grothoff
23 * @author Milan Bouchet-Valat
26 * Service for testing and autoconfiguration of
27 * NAT traversal functionality
29 * @defgroup nat NAT testing library
34 #ifndef GNUNET_NAT_AUTO_SERVICE_H
35 #define GNUNET_NAT_AUTO_SERVICE_H
37 #include "gnunet_util_lib.h"
38 #include "gnunet_nat_service.h"
42 * Handle to a NAT test.
44 struct GNUNET_NAT_AUTO_Test;
48 * Start testing if NAT traversal works using the given configuration.
49 * The transport adapters should be down while using this function.
51 * @param cfg configuration for the NAT traversal
52 * @param proto protocol to test, i.e. IPPROTO_TCP or IPPROTO_UDP
53 * @param section_name configuration section to use for configuration
54 * @param report function to call with the result of the test
55 * @param report_cls closure for @a report
56 * @return handle to cancel NAT test
58 struct GNUNET_NAT_AUTO_Test *
59 GNUNET_NAT_AUTO_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
61 const char *section_name,
62 GNUNET_NAT_TestCallback report,
67 * Stop an active NAT test.
69 * @param tst test to stop.
72 GNUNET_NAT_AUTO_test_stop (struct GNUNET_NAT_AUTO_Test *tst);
76 * Handle to auto-configuration in progress.
78 struct GNUNET_NAT_AUTO_AutoHandle;
82 * Converts `enum GNUNET_NAT_StatusCode` to string
84 * @param err error code to resolve to a string
85 * @return point to a static string containing the error code
88 GNUNET_NAT_AUTO_status2string (enum GNUNET_NAT_StatusCode err);
92 * Function called with the result from the autoconfiguration.
95 * @param diff minimal suggested changes to the original configuration
96 * to make it work (as best as we can)
97 * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
98 * @param type what the situation of the NAT
101 (*GNUNET_NAT_AUTO_AutoResultCallback)(void *cls,
102 const struct GNUNET_CONFIGURATION_Handle *diff,
103 enum GNUNET_NAT_StatusCode result,
104 enum GNUNET_NAT_Type type);
108 * Start auto-configuration routine. The transport adapters should
109 * be stopped while this function is called.
111 * @param cfg initial configuration
112 * @param cb function to call with autoconfiguration result
113 * @param cb_cls closure for @a cb
114 * @return handle to cancel operation
116 struct GNUNET_NAT_AUTO_AutoHandle *
117 GNUNET_NAT_AUTO_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
118 GNUNET_NAT_AUTO_AutoResultCallback cb,
123 * Abort autoconfiguration.
125 * @param ah handle for operation to abort
128 GNUNET_NAT_AUTO_autoconfig_cancel (struct GNUNET_NAT_AUTO_AutoHandle *ah);
133 /** @} */ /* end of group */
135 /* end of gnunet_nat_auto_service.h */