/*
This file is part of GNUnet.
- Copyright (C) 2007-2014 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2007-2014 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
*/
/**
- * @file include/gnunet_nat_lib.h
- * @brief Library handling UPnP and NAT-PMP port forwarding and
- * external IP address retrieval
* @author Christian Grothoff
* @author Milan Bouchet-Valat
+ *
+ * @file
+ * Library handling UPnP and NAT-PMP port forwarding
+ * and external IP address retrieval
+ *
+ * @defgroup nat NAT library
+ * Library handling UPnP and NAT-PMP port forwarding
+ * and external IP address retrieval
+ *
+ * @{
*/
#ifndef GNUNET_NAT_LIB_H
* 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_ERROR_HELPER_NAT_CLIENT_NOT_FOUND,
-
-
/**
*
*/
* @param addr the address, NULL on errors
* @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,
- enum GNUNET_NAT_StatusCode result);
-
+typedef void
+(*GNUNET_NAT_IPCallback) (void *cls,
+ const struct in_addr *addr,
+ enum GNUNET_NAT_StatusCode result);
/**
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);
/**
- * Make Generic STUN request and
- * Send a generic stun request to the server specified using the specified socket.
- * possibly waiting for a reply and filling the 'reply' field with
- * the externally visible address.
- *
+ * Handle to a request given to the resolver. Can be used to cancel
+ * the request prior to the timeout or successful execution. Also
+ * used to track our internal state for the request.
+ */
+struct GNUNET_NAT_STUN_Handle;
+
- * @param server, the address of the stun server
- * @param port, port of the stun server
+/**
+ * Make generic STUN request. Sends a generic stun request to the
+ * server specified using the specified socket. The caller must
+ * wait for a reply on the @a sock and call
+ * #GNUNET_NAT_stun_handle_packet() if a reply is received.
+ *
+ * @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_OK success, #GNUNET_NO on error.
+ * @param cb callback in case of error (or completion)
+ * @param cb_cls closure for @a cb
+ * @return NULL on error
*/
-int
-GNUNET_NAT_stun_make_request(char * server,
- int port,
- struct GNUNET_NETWORK_Handle * sock, GNUNET_NAT_stun_RequestCallback cb,
- void *cb_cls);
+struct GNUNET_NAT_STUN_Handle *
+GNUNET_NAT_stun_make_request (const char *server,
+ uint16_t port,
+ struct GNUNET_NETWORK_Handle *sock,
+ GNUNET_NAT_STUN_ErrorCallback cb,
+ void *cb_cls);
/**
+ * Cancel active STUN request. Frees associated resources
+ * and ensures that the callback is no longer invoked.
*
- * 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, the packet
- * @param len, the length of the packet
- * @param arg, sockaddr_in where we will set our discovered packet
+ * @param rh request to cancel
+ */
+void
+GNUNET_NAT_stun_make_request_cancel (struct GNUNET_NAT_STUN_Handle *rh);
+
+
+/**
+ * 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.
*
- * @return, #GNUNET_OK on OK, #GNUNET_NO if the packet is invalid ( not a stun packet)
+ * @param data the packet
+ * @param len the length of the packet
+ * @param arg sockaddr_in where we will set our discovered packet
+ * @return #GNUNET_OK on OK,
+ * #GNUNET_NO if the packet is not a stun packet
*/
int
-GNUNET_NAT_stun_handle_packet(const void *data,
- size_t len,
- struct sockaddr_in *arg);
+GNUNET_NAT_stun_handle_packet (const void *data,
+ size_t len,
+ 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 the NAT handle
- * @param data, packet
- * @param len, packet length
- *
- * @return #GNUNET_NO if it can't decode,# GNUNET_YES if is a packet
+ * @param data packet
+ * @param len length of @a data
+ * @return #GNUNET_NO if it can't decode, #GNUNET_YES if is a packet
*/
int
-GNUNET_NAT_is_valid_stun_packet(void *cls,
- const void *data,
- size_t len);
-
+GNUNET_NAT_is_valid_stun_packet (void *cls,
+ const void *data,
+ size_t len);
#endif
+/** @} */ /* end of group */
+
/* end of gnunet_nat_lib.h */
projects / oweals / gnunet.git / blobdiff