ACE  6.3.3
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
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]

Public Member Functions

int set_option (int level, int option, void *optval, int optlen) const
 Wrapper around the setsockopt system call. More...
 
int get_option (int level, int option, void *optval, int *optlen) const
 Wrapper around the getsockopt system call. More...
 
int close (void)
 
int get_local_addr (ACE_Addr &) const
 
int get_remote_addr (ACE_Addr &) const
 
void dump (void) const
 Dump the state of an object. More...
 
int open (int type, int protocol_family, int protocol, int reuse_addr)
 Wrapper around the BSD-style socket system call (no QoS). More...
 
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. More...
 
- Public Member Functions inherited from ACE_IPC_SAP
int control (int cmd, void *) const
 Interface for <ioctl>. More...
 
int enable (int value) const
 
int disable (int value) const
 
ACE_HANDLE get_handle (void) const
 Get the underlying handle. More...
 
void set_handle (ACE_HANDLE handle)
 Set the underlying handle. More...
 
void dump (void) const
 Dump the state of an object. More...
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
- Public Attributes inherited from ACE_IPC_SAP
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

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)
 
 ~ACE_SOCK (void)
 Protected destructor. More...
 
- Protected Member Functions inherited from ACE_IPC_SAP
 ACE_IPC_SAP (void)
 Default constructor. More...
 
 ~ACE_IPC_SAP (void)
 Protected destructor. More...
 

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_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.

ACE_SOCK::~ACE_SOCK ( void  )
inlineprotected

Protected destructor.

Not a virtual destructor. Protected destructor to prevent operator delete() from being called through a base class ACE_SOCK pointer/reference.

Member Function Documentation

int ACE_SOCK::close ( void  )

Close the socket. This method also sets the object's handle value to ACE_INVALID_HANDLE.

Returns
The result of closing the socket; 0 if the handle value was already ACE_INVALID_HANDLE.
void ACE_SOCK::dump ( void  ) const

Dump the state of an object.

int ACE_SOCK::get_local_addr ( ACE_Addr sa) const

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

int ACE_SOCK::get_option ( int  level,
int  option,
void *  optval,
int *  optlen 
) const
inline

Wrapper around the getsockopt system call.

int ACE_SOCK::get_remote_addr ( ACE_Addr sa) const

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

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

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

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::set_option ( int  level,
int  option,
void *  optval,
int  optlen 
) const
inline

Wrapper around the setsockopt system call.

Member Data Documentation

ACE_SOCK::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.


The documentation for this class was generated from the following files: