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)
*/
* @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);
/**
/**
- * 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);
/**
* @param server, the address of the stun server
* @param port, port of the stun server
* @param sock the socket used to send the request
- * @return GNUNET_NAT_STUN_Handle on success, NULL on error.
+ * @param cb callback in case of error
+ * @return #GNUNET_OK success, #GNUNET_NO on error.
*/
-struct GNUNET_NAT_STUN_Handle *
+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);
/**
+ *
* Handle an incoming STUN message, Do some basic sanity checks on packet size and content,
* try to extract a bit of information, and possibly reply.
* At the moment this only processes BIND requests, and returns
* the externally visible address of the request.
* If a callback is specified, invoke it with the attribute.
*
- * @param data, pointer where we will set the type
- * @param len, pointer where we will set the type
- * @param st, pointer where we will set the type
+ * @param data, the packet
+ * @param len, the length of the packet
+ * @param arg, sockaddr_in where we will set our discovered packet
*
- * @return, 0 on IGNORE, -1 if the packet is invalid ( not a stun packet)
+ * @return, #GNUNET_OK on OK, #GNUNET_NO if the packet is invalid ( not a stun packet)
*/
int
GNUNET_NAT_stun_handle_packet(const void *data,
struct sockaddr_in *arg);
/**
- * CHECK if is a valid STUN packet sending to GNUNET_NAT_stun_handle_packet
+ * CHECK if is a valid STUN packet sending to GNUNET_NAT_stun_handle_packet.
+ * It also check if it can handle the packet based on the NAT handler.
+ * You don't need to call anything else to check if the packet is valid,
*
- * @param cls, NAT callback
- * @param data, pointer where we will set the type
- * @param len, pointer where we will set the type
- * @param st, pointer where we will set the type
+ * @param cls the NAT handle
+ * @param data, packet
+ * @param len, packet length
*
- * @return, 0 on IGNORE, -1 if the packet is invalid ( not a stun packet)
+ * @return #GNUNET_NO if it can't decode,# GNUNET_YES if is a packet
*/
int
-GNUNET_NAT_try_decode_stun_packet(void *cls,
+GNUNET_NAT_is_valid_stun_packet(void *cls,
const void *data,
size_t len);