-avoid 'hu', as it is unsigned short, not uint16_t

[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..5303766582e41ecd4ece80537253a5d6df08f2eb 100644 (file)
--- a/src/include/gnunet_nat_lib.h
+++ b/src/include/gnunet_nat_lib.h
@@ -73,11 +73,22 @@ 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_NOT_ONLINE,
   
   /**
    * `upnpc` command not found
@@ -104,19 +115,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 +250,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);
@@ -297,7 +340,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