updated API doc for socket.h
authorMartin Willi <martin@strongswan.org>
Thu, 13 Nov 2008 07:48:27 +0000 (07:48 -0000)
committerMartin Willi <martin@strongswan.org>
Thu, 13 Nov 2008 07:48:27 +0000 (07:48 -0000)
src/charon/network/socket.h

index 2f1f627..79821a2 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
- * Copyright (C) 2005-2006 Martin Willi
+ * Copyright (C) 2005-2008 Martin Willi
  * Copyright (C) 2005 Jan Hutter
  * Hochschule fuer Technik Rapperswil
  *
@@ -35,10 +35,8 @@ typedef struct socket_t socket_t;
 /**
  * Maximum size of a packet.
  *
- * 3000 Bytes should be sufficient, see IKEv2 RFC. However, we currently
- * do not support HASH_AND_URL certificates, so we require to transmit
- * the full certificates. To run our multi-CA test with 2 intermediate CAs,
- * 5000 bytes is sufficient.
+ * 3000 Bytes should be sufficient, see IKEv2 RFC. However, to run our
+ * multi-CA test with 2 intermediate CAs, we increase that to 5000 bytes.
  */
 #define MAX_PACKET 5000
 
@@ -73,9 +71,8 @@ struct socket_t {
        /**
         * Send a packet.
         * 
-        * Sends a packet to the net using destination from the packet.
-        * Packet is sent using default routing mechanisms, thus the 
-        * source address in packet is ignored.
+        * Sends a packet to the net using source and destination addresses of
+        * the packet.
         * 
         * @param packet                packet_t to send
         * @return                              
@@ -85,9 +82,9 @@ struct socket_t {
        status_t (*send) (socket_t *this, packet_t *packet);
        
        /**
-        * Enumerate the underlying sockets.
+        * Enumerate all underlying socket file descriptors.
         * 
-        * @return                              enumerator_t object
+        * @return                              enumerator over (int fd, int family, int port)
         */
        enumerator_t *(*create_enumerator) (socket_t *this);