print active/inactive information

[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 40a5135bde5c0752d437a369c3f675d85a437716..ebedc4ba4f89708324f0bcd44e19e5e6e6a83519 100644 (file)
--- a/src/include/gnunet_nat_lib.h
+++ b/src/include/gnunet_nat_lib.h
@@ -73,11 +73,27 @@ struct GNUNET_NAT_Handle;
 /**
  * Error Types for the NAT subsystem (which can then later be converted/resolved to a string)
  */
-enum GNUNET_NAT_FailureCode {
+enum GNUNET_NAT_FailureCode 
+{
   /**
    * Just the default
    */
-  GNUNET_NAT_ERROR_SUCCESS = 0,
+  GNUNET_NAT_ERROR_SUCCESS = GNUNET_OK,
+  
+  /**
+   * `external-ip' command not found
+   */
+  GNUNET_NAT_ERROR_IPC_FAILURE,
+  
+  /**
+   * `external-ip' command not found
+   */
+  GNUNET_NAT_ERROR_TIMEOUT,
+  
+  /**
+   * `external-ip' command not found
+   */
+  GNUNET_NAT_ERROR_NOT_ONLINE,
   
   /**
    * `upnpc` command not found
@@ -104,19 +120,51 @@ enum GNUNET_NAT_FailureCode {
    */
   GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND,
   
+  /**
+   * `external-ip' command not found
+   */
+  GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_EXECUTEABLE,
+  
+  /**
+   * `external-ip' command not found
+   */
+  GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID,
+  
   /**
    * "no valid address was returned by `external-ip'"
    */
-  GNUNET_NAT_ERROR_EXTERNAL_IP_NO_VALID_ADDRESS_FOUND,
+  GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID,
   
+  /**
+   * Could not determine interface with internal/local network address
+   */
+  GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO,
+          
+  /**
+   * No working gnunet-helper-nat-server found
+   */
+  GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND,
   
+  /**
+   * NAT test could not be initialized
+   */
+  GNUNET_NAT_ERROR_NAT_TEST_START_FAILED,
+  
+  /**
+   * NAT test timeout
+   */
+  GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT,
   
   /**
    * 
    */
-  GNUNET_NAT_ERROR_,
+  GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND,
   
   
+  /**
+   * 
+   */
+  GNUNET_NAT_ERROR_
 };
 
 
@@ -207,7 +255,7 @@ struct GNUNET_NAT_Test;
  * NAT configuration test.
  *
  * @param cls closure
- * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
+ * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
  */
 typedef void (*GNUNET_NAT_TestCallback) (void *cls,
                                          enum GNUNET_NAT_FailureCode result);
@@ -221,6 +269,7 @@ typedef void (*GNUNET_NAT_TestCallback) (void *cls,
  * @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
  * @param bnd_port port to bind to, 0 for connection reversal
  * @param adv_port externally advertised port to use
+ * @param timeout delay after which the test should be aborted
  * @param report function to call with the result of the test
  * @param report_cls closure for @a report
  * @return handle to cancel NAT test
@@ -230,6 +279,7 @@ GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
                        int is_tcp,
                        uint16_t bnd_port,
                        uint16_t adv_port,
+                       struct GNUNET_TIME_Relative timeout,
                        GNUNET_NAT_TestCallback report,
                        void *report_cls);
 
@@ -297,7 +347,7 @@ struct GNUNET_NAT_MiniHandle;
  *
  * @param cls closure
  * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
- *     the previous (now invalid) one
+ *     the previous (now invalid) one, #GNUNET_SYSERR indicates an error
  * @param addr either the previous or the new public IP address
  * @param addrlen actual length of the @a addr
  * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code