diff options
Diffstat (limited to 'ace/Sock_Connect.h')
| -rw-r--r-- | ace/Sock_Connect.h | 48 |
1 files changed, 32 insertions, 16 deletions
diff --git a/ace/Sock_Connect.h b/ace/Sock_Connect.h index 6309753990e..ef6513fb7f3 100644 --- a/ace/Sock_Connect.h +++ b/ace/Sock_Connect.h @@ -1,4 +1,14 @@ -// $Id$ + +//============================================================================= +/** + * @file Sock_Connect.h + * + * $Id$ + * + * @author Priyanka Gontla <pgontla@ece.uci.edu> + */ +//============================================================================= + #ifndef ACE_SOCK_CONNECT_H #define ACE_SOCK_CONNECT_H @@ -19,36 +29,42 @@ class ACE_Export ACE_Sock_Connect // = Socket connection establishment calls. + /// Bind a new unused port to <handle>. static int bind_port (ACE_HANDLE handle, ACE_UINT32 ip_addr = INADDR_ANY); - // Bind a new unused port to <handle>. + /** + * Get our broadcast address based on our <host_addr>. If + * <hostname> is non-0 we'll use it to determine our IP address. If + * <handle> is not <ACE_INVALID_HANDLE> then we'll use this to + * determine our broadcast address, otherwise we'll have to create a + * socket internally (and free it). Returns -1 on failure and 0 on + * success. + */ static int get_bcast_addr (ACE_UINT32 &bcast_addr, const ACE_TCHAR *hostname = 0, ACE_UINT32 host_addr = 0, ACE_HANDLE handle = ACE_INVALID_HANDLE); - // Get our broadcast address based on our <host_addr>. If - // <hostname> is non-0 we'll use it to determine our IP address. If - // <handle> is not <ACE_INVALID_HANDLE> then we'll use this to - // determine our broadcast address, otherwise we'll have to create a - // socket internally (and free it). Returns -1 on failure and 0 on - // success. + /** + * Return count and array of all configured IP interfaces on this + * host, rc = 0 on success (count == number of interfaces else -1). + * Caller is responsible for calling delete [] on <addr_array>. + */ static int get_ip_interfaces (size_t &count, ACE_INET_Addr *&addr_array); - // Return count and array of all configured IP interfaces on this - // host, rc = 0 on success (count == number of interfaces else -1). - // Caller is responsible for calling delete [] on <addr_array>. + /** + * Helper routine for get_ip_interfaces, differs by UNIX platform so + * put into own subroutine. perform some ioctls to retrieve ifconf + * list of ifreq structs. + */ static int count_interfaces (ACE_HANDLE handle, size_t &how_many); - // Helper routine for get_ip_interfaces, differs by UNIX platform so - // put into own subroutine. perform some ioctls to retrieve ifconf - // list of ifreq structs. + /// Routine to return a handle from which <ioctl> requests can be + /// made. Caller must <close> the handle. static ACE_HANDLE get_handle (void); - // Routine to return a handle from which <ioctl> requests can be - // made. Caller must <close> the handle. }; |