ACE_SOCK Class Reference

An abstract class that forms the basis for more specific classes, such as <ACE_SOCK_Acceptor> and <ACE_SOCK_Stream>. Do not instantiate this class. More...

#include <SOCK.h>

Inheritance diagram for ACE_SOCK:

Inheritance graph
[legend]
Collaboration diagram for ACE_SOCK:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ~ACE_SOCK (void)
 Default ctor/dtor.
int set_option (int level, int option, void *optval, int optlen) const
 Wrapper around the <setsockopt> system call.
int get_option (int level, int option, void *optval, int *optlen) const
 Wrapper around the <getsockopt> system call.
int close (void)
 Close down the socket handle.
int get_local_addr (ACE_Addr &) const
int get_remote_addr (ACE_Addr &) const
void dump (void) const
 Dump the state of an object.
int open (int type, int protocol_family, int protocol, int reuse_addr)
 Wrapper around the BSD-style <socket> system call (no QoS).
int open (int type, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, u_long flags, int reuse_addr)
 Wrapper around the QoS-enabled <WSASocket> function.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Protected Member Functions

 ACE_SOCK (int type, int protocol_family, int protocol=0, int reuse_addr=0)
 ACE_SOCK (int type, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, u_long flags, int reuse_addr)
 ACE_SOCK (void)

Detailed Description

An abstract class that forms the basis for more specific classes, such as <ACE_SOCK_Acceptor> and <ACE_SOCK_Stream>. Do not instantiate this class.

This class provides functions that are common to all of the <ACE_SOCK_*> classes. <ACE_SOCK> provides the ability to get and set socket options, get the local and remote addresses, and open and close a socket handle.


Constructor & Destructor Documentation

ACE_INLINE ACE_SOCK::~ACE_SOCK void   ) 
 

Default ctor/dtor.

ACE_SOCK::ACE_SOCK int  type,
int  protocol_family,
int  protocol = 0,
int  reuse_addr = 0
[protected]
 

Constructor with arguments to call the BSD-style <socket> system call (no QoS).

ACE_SOCK::ACE_SOCK int  type,
int  protocol_family,
int  protocol,
ACE_Protocol_Info protocolinfo,
ACE_SOCK_GROUP  g,
u_long  flags,
int  reuse_addr
[protected]
 

Constructor with arguments to call the QoS-enabled <WSASocket> function.

ACE_SOCK::ACE_SOCK void   )  [protected]
 

Default constructor is protected to prevent instances of this class from being defined.


Member Function Documentation

int ACE_SOCK::close void   ) 
 

Close down the socket handle.

Reimplemented in ACE_MEM_Stream, ACE_SOCK_Acceptor, ACE_SOCK_Dgram_Bcast, ACE_SOCK_SEQPACK_Acceptor, ACE_SOCK_SEQPACK_Association, and ACE_SOCK_Stream.

void ACE_SOCK::dump void   )  const
 

Dump the state of an object.

Reimplemented from ACE_IPC_SAP.

Reimplemented in ACE_LSOCK_Acceptor, ACE_LSOCK_CODgram, ACE_LSOCK_Dgram, ACE_LSOCK_Stream, ACE_MEM_Acceptor, ACE_MEM_IO, ACE_MEM_Stream, ACE_SOCK_Acceptor, ACE_SOCK_CODgram, ACE_SOCK_Dgram, ACE_SOCK_Dgram_Bcast, ACE_SOCK_Dgram_Mcast, ACE_SOCK_IO, ACE_SOCK_SEQPACK_Acceptor, ACE_SOCK_SEQPACK_Association, and ACE_SOCK_Stream.

int ACE_SOCK::get_local_addr ACE_Addr  )  const
 

Return the local endpoint address in the referenced <ACE_Addr>. Returns 0 if successful, else -1.

Reimplemented in ACE_LSOCK_Acceptor, and ACE_LSOCK_Stream.

ACE_INLINE int ACE_SOCK::get_option int  level,
int  option,
void *  optval,
int *  optlen
const
 

Wrapper around the <getsockopt> system call.

int ACE_SOCK::get_remote_addr ACE_Addr  )  const
 

Return the address of the remotely connected peer (if there is one), in the referenced <ACE_Addr>. Returns 0 if successful, else -1.

Reimplemented in ACE_LSOCK_Stream, ACE_SOCK_Acceptor, ACE_SOCK_Dgram, ACE_SOCK_Dgram_Bcast, and ACE_SOCK_SEQPACK_Acceptor.

int ACE_SOCK::open int  type,
int  protocol_family,
int  protocol,
ACE_Protocol_Info protocolinfo,
ACE_SOCK_GROUP  g,
u_long  flags,
int  reuse_addr
 

Wrapper around the QoS-enabled <WSASocket> function.

int ACE_SOCK::open int  type,
int  protocol_family,
int  protocol,
int  reuse_addr
 

Wrapper around the BSD-style <socket> system call (no QoS).

ACE_INLINE int ACE_SOCK::set_option int  level,
int  option,
void *  optval,
int  optlen
const
 

Wrapper around the <setsockopt> system call.


Member Data Documentation

ACE_SOCK::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

Reimplemented from ACE_IPC_SAP.

Reimplemented in ACE_LSOCK_Acceptor, ACE_LSOCK_CODgram, ACE_LSOCK_Dgram, ACE_LSOCK_Stream, ACE_MEM_Acceptor, ACE_MEM_IO, ACE_MEM_Stream, ACE_SOCK_Acceptor, ACE_SOCK_CODgram, ACE_SOCK_Dgram, ACE_SOCK_Dgram_Bcast, ACE_SOCK_Dgram_Mcast, ACE_SOCK_IO, ACE_SOCK_SEQPACK_Acceptor, ACE_SOCK_SEQPACK_Association, and ACE_SOCK_Stream.


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 15:50:31 2005 for ACE by  doxygen 1.4.5