struct GNUNET_NAT_Handle;
+/**
+ * Error Types for the NAT subsystem (which can then later be converted/resolved to a string)
+ */
+enum GNUNET_NAT_FailureCode
+{
+ /**
+ * Just the default
+ */
+ 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
+ */
+ GNUNET_NAT_ERROR_UPNPC_NOT_FOUND,
+
+ /**
+ * Failed to run `upnpc` command
+ */
+ GNUNET_NAT_ERROR_UPNPC_FAILED,
+
+ /**
+ * `upnpc' command took too long, process killed
+ */
+ GNUNET_NAT_ERROR_UPNPC_TIMEOUT,
+
+ /**
+ * `upnpc' command failed to establish port mapping
+ */
+ GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED,
+
+ /**
+ * `external-ip' command not found
+ */
+ 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_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_HELPER_NAT_CLIENT_NOT_FOUND,
+
+
+ /**
+ *
+ */
+ GNUNET_NAT_ERROR_
+};
+
+
/**
* Attempt to enable port redirection and detect public IP address
* contacting UPnP or NAT-PMP routers on the local network. Use addr
* 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)
- * @param emsg NULL on success, otherwise may include an error message
+ * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
*/
typedef void (*GNUNET_NAT_TestCallback) (void *cls,
- int success,
- const char *emsg);
+ enum GNUNET_NAT_FailureCode result);
/**
* @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
int is_tcp,
uint16_t bnd_port,
uint16_t adv_port,
+ struct GNUNET_TIME_Relative timeout,
GNUNET_NAT_TestCallback report,
void *report_cls);
*
* @param cls closure
* @param addr the address, NULL on errors
- * @param emsg NULL on success, otherwise may include an error message
+ * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
*/
typedef void (*GNUNET_NAT_IPCallback) (void *cls,
const struct in_addr *addr,
- const char *emsg);
+ enum GNUNET_NAT_FailureCode result);
*
* @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
*/
typedef void
(*GNUNET_NAT_MiniAddressCallback) (void *cls,
int add_remove,
const struct sockaddr *addr,
socklen_t addrlen,
- const char *emsg);
+ enum GNUNET_NAT_FailureCode result);
/**
* @param cls closure
* @param diff minimal suggested changes to the original configuration
* to make it work (as best as we can)
- * @param emsg NULL on success, otherwise may include an error message
+ * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
*/
typedef void
(*GNUNET_NAT_AutoResultCallback)(void *cls,
const struct GNUNET_CONFIGURATION_Handle *diff,
- const char *emsg);
+ enum GNUNET_NAT_FailureCode result);
/**