From: Christian Grothoff <christian@grothoff.org>
Date: Fri, 1 Jul 2011 10:38:08 +0000 (+0000)
Subject: draft for NAT_test API
X-Git-Tag: initial-import-from-subversion-38251~17998
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=34679adf5a4d083ddd39da805e7509429fed7f45;p=oweals%2Fgnunet.git

draft for NAT_test API
---

diff --git a/src/include/gnunet_nat_lib.h b/src/include/gnunet_nat_lib.h
index 9550bb1e3..07f6ca5e8 100644
--- a/src/include/gnunet_nat_lib.h
+++ b/src/include/gnunet_nat_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2007, 2008, 2009, 2010 Christian Grothoff (and other contributing authors)
+     (C) 2007, 2008, 2009, 2010, 2011 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
@@ -138,6 +138,54 @@ GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
 void 
 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h);
 
+
+/**
+ * Handle to a NAT test.
+ */
+struct GNUNET_NAT_Test;
+
+/**
+ * Function called to report success or failure for
+ * NAT configuration test.
+ *
+ * @param cls closure
+ * @param success GNUNET_OK on success, GNUNET_NO on failure,
+ *                GNUNET_SYSERR if the test could not be 
+ *                properly started (internal failure)
+ */
+typedef void (*GNUNET_NAT_TestCallback)(void *cls,
+					int success);
+
+/**
+ * Start testing if NAT traversal works using the
+ * given configuration (IPv4-only).
+ *
+ * @param cfg configuration for the NAT traversal
+ * @param is_tcp GNUNET_YES to test TCP, GNUNET_NO to test UDP
+ * @param bnd_port port to bind to
+ * @param adv_port externally advertised port to use
+ * @param report function to call with the result of the test
+ * @param report_cls closure for report
+ * @return handle to cancel NAT test
+ */
+struct GNUNET_NAT_Test *
+GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
+		       int is_tcp,
+		       uint16_t bnd_port,
+		       uint16_t adv_port,
+		       GNUNET_NAT_TestCallback report,
+		       void *report_cls);
+
+
+/**
+ * Stop an active NAT test.
+ *
+ * @param tst test to stop.
+ */
+void
+GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst);
+
+
 #endif 
 
 /* end of gnunet_nat_lib.h */
diff --git a/src/nat/Makefile.am b/src/nat/Makefile.am
index 75798a252..7b738df4e 100644
--- a/src/nat/Makefile.am
+++ b/src/nat/Makefile.am
@@ -43,7 +43,7 @@ endif
 lib_LTLIBRARIES = libgnunetnat.la
 
 libgnunetnat_la_SOURCES = \
-  nat.c 
+  nat.c nat_test.c nat.h
 
 libgnunetnat_la_LIBADD = \
   $(top_builddir)/src/util/libgnunetutil.la \
diff --git a/src/nat/gnunet-nat-server.c b/src/nat/gnunet-nat-server.c
index ae831db08..f2508a94a 100644
--- a/src/nat/gnunet-nat-server.c
+++ b/src/nat/gnunet-nat-server.c
@@ -22,7 +22,6 @@
  * @file src/nat/gnunet-nat-server.c
  * @brief Daemon to run on 'gnunet.org' to help test NAT traversal code
  * @author Christian Grothoff
- *
  */
 #include "platform.h"
 #include "gnunet_util_lib.h"
diff --git a/src/nat/nat_test.c b/src/nat/nat_test.c
new file mode 100644
index 000000000..f31c5059d
--- /dev/null
+++ b/src/nat/nat_test.c
@@ -0,0 +1,78 @@
+/*
+     This file is part of GNUnet.
+     (C) 2011 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 3, 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.
+*/
+
+/**
+ * @file nat/nat_test.c
+ * @brief functions to test if the NAT configuration is successful at achieving NAT traversal (with the help of a gnunet-nat-server)
+ * @author Christian Grothoff
+ */
+#include "platform.h"
+#include "gnunet_util_lib.h"
+#include "gnunet_nat_lib.h"
+#include "nat.h"
+
+
+/**
+ * Handle to a NAT test.
+ */
+struct GNUNET_NAT_Test
+{
+  GNUNET_NAT_TestCallback report;
+  
+  void *report_cls;
+};
+
+
+/**
+ * Start testing if NAT traversal works using the
+ * given configuration (IPv4-only).
+ *
+ * @param cfg configuration for the NAT traversal
+ * @param is_tcp GNUNET_YES to test TCP, GNUNET_NO to test UDP
+ * @param bnd_port port to bind to
+ * @param adv_port externally advertised port to use
+ * @param report function to call with the result of the test
+ * @param report_cls closure for report
+ * @return handle to cancel NAT test
+ */
+struct GNUNET_NAT_Test *
+GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
+		       int is_tcp,
+		       uint16_t bnd_port,
+		       uint16_t adv_port,
+		       GNUNET_NAT_TestCallback report,
+		       void *report_cls)
+{
+  return NULL;
+}
+
+
+/**
+ * Stop an active NAT test.
+ *
+ * @param tst test to stop.
+ */
+void
+GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst)
+{
+  GNUNET_free (tst);
+}
+
+/* end of nat_test.c */