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/>.
20 * @author Christian Grothoff
21 * @author Milan Bouchet-Valat
24 * Service for testing and autoconfiguration of
25 * NAT traversal functionality
27 * @defgroup nat NAT testing library
32 #ifndef GNUNET_NAT_AUTO_SERVICE_H
33 #define GNUNET_NAT_AUTO_SERVICE_H
35 #include "gnunet_util_lib.h"
36 #include "gnunet_nat_service.h"
40 * Handle to a NAT test.
42 struct GNUNET_NAT_AUTO_Test;
46 * Start testing if NAT traversal works using the given configuration.
47 * The transport adapters should be down while using this function.
49 * @param cfg configuration for the NAT traversal
50 * @param proto protocol to test, i.e. IPPROTO_TCP or IPPROTO_UDP
51 * @param section_name configuration section to use for configuration
52 * @param report function to call with the result of the test
53 * @param report_cls closure for @a report
54 * @return handle to cancel NAT test
56 struct GNUNET_NAT_AUTO_Test *
57 GNUNET_NAT_AUTO_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
59 const char *section_name,
60 GNUNET_NAT_TestCallback report,
65 * Stop an active NAT test.
67 * @param tst test to stop.
70 GNUNET_NAT_AUTO_test_stop (struct GNUNET_NAT_AUTO_Test *tst);
74 * Handle to auto-configuration in progress.
76 struct GNUNET_NAT_AUTO_AutoHandle;
80 * Converts `enum GNUNET_NAT_StatusCode` to string
82 * @param err error code to resolve to a string
83 * @return point to a static string containing the error code
86 GNUNET_NAT_AUTO_status2string (enum GNUNET_NAT_StatusCode err);
90 * Function called with the result from the autoconfiguration.
93 * @param diff minimal suggested changes to the original configuration
94 * to make it work (as best as we can)
95 * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
96 * @param type what the situation of the NAT
99 (*GNUNET_NAT_AUTO_AutoResultCallback)(void *cls,
100 const struct GNUNET_CONFIGURATION_Handle *diff,
101 enum GNUNET_NAT_StatusCode result,
102 enum GNUNET_NAT_Type type);
106 * Start auto-configuration routine. The transport adapters should
107 * be stopped while this function is called.
109 * @param cfg initial configuration
110 * @param cb function to call with autoconfiguration result
111 * @param cb_cls closure for @a cb
112 * @return handle to cancel operation
114 struct GNUNET_NAT_AUTO_AutoHandle *
115 GNUNET_NAT_AUTO_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
116 GNUNET_NAT_AUTO_AutoResultCallback cb,
121 * Abort autoconfiguration.
123 * @param ah handle for operation to abort
126 GNUNET_NAT_AUTO_autoconfig_cancel (struct GNUNET_NAT_AUTO_AutoHandle *ah);
131 /** @} */ /* end of group */
133 /* end of gnunet_nat_auto_service.h */