Changeset 4647

Show
Ignore:
Timestamp:
11/13/08 08:48:27 (2 months ago)
Author:
martin
Message:

updated API doc for socket.h

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/src/charon/network/socket.h

    r4618 r4647  
    11/* 
    22 * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger 
    3  * Copyright (C) 2005-2006 Martin Willi 
     3 * Copyright (C) 2005-2008 Martin Willi 
    44 * Copyright (C) 2005 Jan Hutter 
    55 * Hochschule fuer Technik Rapperswil 
    …… 
    3636 * Maximum size of a packet. 
    3737 * 
    38  * 3000 Bytes should be sufficient, see IKEv2 RFC. However, we currently 
    39  * do not support HASH_AND_URL certificates, so we require to transmit 
    40  * the full certificates. To run our multi-CA test with 2 intermediate CAs, 
    41  * 5000 bytes is sufficient. 
     38 * 3000 Bytes should be sufficient, see IKEv2 RFC. However, to run our 
     39 * multi-CA test with 2 intermediate CAs, we increase that to 5000 bytes. 
    4240 */ 
    4341#define MAX_PACKET 5000 
    …… 
    7472     * Send a packet. 
    7573     *  
    76      * Sends a packet to the net using destination from the packet. 
    77      * Packet is sent using default routing mechanisms, thus the  
    78      * source address in packet is ignored. 
     74     * Sends a packet to the net using source and destination addresses of 
     75     * the packet. 
    7976     *  
    8077     * @param packet        packet_t to send 
    …… 
    8683     
    8784    /** 
    88      * Enumerate the underlying sockets. 
     85     * Enumerate all underlying socket file descriptors. 
    8986     *  
    90      * @return              enumerator_t object 
     87     * @return              enumerator over (int fd, int family, int port) 
    9188     */ 
    9289    enumerator_t *(*create_enumerator) (socket_t *this);