SET service: accurate results for symmetric mode

[oweals/gnunet.git] / src / include / gnunet_nat_lib.h

diff --git a/src/include/gnunet_nat_lib.h b/src/include/gnunet_nat_lib.h
index 3e9d8171c5d471639c46fc09e882466bb106be36..88f8f6d65fec8742848f57e71480177962ae669f 100644 (file)
--- a/src/include/gnunet_nat_lib.h
+++ b/src/include/gnunet_nat_lib.h
@@ -70,6 +70,31 @@ typedef void
 struct GNUNET_NAT_Handle;
 
 
+
+/**
+ * What the situation of the NAT connectivity
+ */
+enum GNUNET_NAT_Type
+{
+  /**
+   * We have a direct connection
+   */
+  GNUNET_NAT_TYPE_NO_NAT = GNUNET_OK,
+  /**
+   * We are under a NAT but cannot traverse it
+   */
+  GNUNET_NAT_TYPE_UNREACHABLE_NAT,
+  /**
+   * We can traverse using STUN
+   */
+  GNUNET_NAT_TYPE_STUN_PUNCHED_NAT,
+  /**
+   * WE can traverse using UPNP
+   */
+  GNUNET_NAT_TYPE_UPNP_NAT
+
+};
+
 /**
  * Error Types for the NAT subsystem (which can then later be converted/resolved to a string)
  */
@@ -428,11 +453,13 @@ struct GNUNET_NAT_AutoHandle;
  * @param diff minimal suggested changes to the original configuration
  *             to make it work (as best as we can)
  * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
+ * @param type what the situation of the NAT
  */
 typedef void
 (*GNUNET_NAT_AutoResultCallback)(void *cls,
                                  const struct GNUNET_CONFIGURATION_Handle *diff,
-                                 enum GNUNET_NAT_StatusCode result);
+                                 enum GNUNET_NAT_StatusCode result,
+                                 enum GNUNET_NAT_Type type);
 
 
 /**
@@ -467,16 +494,14 @@ struct GNUNET_NAT_STUN_Handle;
 
 
 /**
- * Function called with the result from NAT request.
+ * Function called with the result if an error happened during STUN request.
  *
  * @param cls closure
- * @param diff minimal suggested changes to the original configuration
- *             to make it work (as best as we can)
- * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
+ * @param result the specific error code
  */
 typedef void
-(*GNUNET_NAT_stun_RequestCallback)(void *cls,
-                                 enum GNUNET_NAT_StatusCode result);
+(*GNUNET_NAT_STUN_ErrorCallback)(void *cls,
+                                 enum GNUNET_NAT_StatusCode error);
 
 
 /**
@@ -489,12 +514,13 @@ typedef void
  * @param server, the address of the stun server
  * @param port, port of the stun server
  * @param sock the socket used to send the request
+ * @param cb callback in case of error
  * @return #GNUNET_OK success, #GNUNET_NO on error.
  */
 int
 GNUNET_NAT_stun_make_request(char * server,
                              int port,
-                             struct GNUNET_NETWORK_Handle * sock, GNUNET_NAT_stun_RequestCallback cb,
+                             struct GNUNET_NETWORK_Handle * sock, GNUNET_NAT_STUN_ErrorCallback cb,
                              void *cb_cls);