ACE  6.0.6
Public Types | Public Member Functions | Public Attributes
ACE_SOCK_CODgram Class Reference

Defines the member functions for the ACE_SOCK connected datagram abstraction. More...

#include <SOCK_CODgram.h>

Inheritance diagram for ACE_SOCK_CODgram:
Inheritance graph
[legend]
Collaboration diagram for ACE_SOCK_CODgram:
Collaboration graph
[legend]

List of all members.

Public Types

typedef ACE_INET_Addr PEER_ADDR

Public Member Functions

 ACE_SOCK_CODgram (void)
 Default constructor.
 ACE_SOCK_CODgram (const ACE_Addr &remote_sap, const ACE_Addr &local_sap=ACE_Addr::sap_any, int protocol_family=ACE_PROTOCOL_FAMILY_INET, int protocol=0, int reuse_addr=0)
 ~ACE_SOCK_CODgram (void)
 Default dtor.
int open (const ACE_Addr &remote_sap, const ACE_Addr &local_sap=ACE_Addr::sap_any, int protocol_family=ACE_PROTOCOL_FAMILY_INET, int protocol=0, int reuse_addr=0)
void dump (void) const
 Dump the state of an object.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Detailed Description

Defines the member functions for the ACE_SOCK connected datagram abstraction.


Member Typedef Documentation


Constructor & Destructor Documentation

ACE_SOCK_CODgram::ACE_SOCK_CODgram ( void  ) [inline]

Default constructor.

ACE_SOCK_CODgram::ACE_SOCK_CODgram ( const ACE_Addr remote_sap,
const ACE_Addr local_sap = ACE_Addr::sap_any,
int  protocol_family = ACE_PROTOCOL_FAMILY_INET,
int  protocol = 0,
int  reuse_addr = 0 
)

Constructor with addresses specified. Calls open(). This constructor binds and/or connects to a specified address, optionally binding an unused port number.

Parameters:
remote_sapThe remote address.
local_sapThe local address.
protocol_familyThe protocol family for the new socket. If either remote_sap or local_sap is specified (i.e., not ACE_Addr::sap_any) its address type is used instead of this value. If both addresses are specified, their address types must match. If neither address is specified, the platform's default IP address type is used.
protocolProtocol value for the new socket.
reuse_addrReuse the local address or not.

There are four possible combinations of remote_sap and local_sap. The behavior in these combinations is:

  • remote_addr == ACE_Addr::sap_any && local_addr == ACE_Addr::sap_any: If protocol_family specifies PF_INET or PF_INET6, bind the local address to a randomly generated port number.
ACE_SOCK_CODgram::~ACE_SOCK_CODgram ( void  ) [inline]

Default dtor.


Member Function Documentation

void ACE_SOCK_CODgram::dump ( void  ) const

Dump the state of an object.

Reimplemented from ACE_SOCK_IO.

Reimplemented in ACE_LSOCK_CODgram.

int ACE_SOCK_CODgram::open ( const ACE_Addr remote_sap,
const ACE_Addr local_sap = ACE_Addr::sap_any,
int  protocol_family = ACE_PROTOCOL_FAMILY_INET,
int  protocol = 0,
int  reuse_addr = 0 
)

Initiate a connected datagram socket, optionally binding an unused port number.

Parameters:
remote_sapThe remote address.
local_sapThe local address.
protocol_familyThe protocol family for the new socket. If either remote_sap or local_sap is specified (i.e., not ACE_Addr::sap_any) its address type is used instead of this value. If both addresses are specified, their address types must match. If neither address is specified, the platform's default IP address type is used.
protocolProtocol value for the new socket.
reuse_addrReuse the local address or not.

There are four possible combinations of remote_sap and local_sap. The behavior in these combinations is:

  • remote_addr == ACE_Addr::sap_any && local_addr == ACE_Addr::sap_any: If protocol_family specifies PF_INET or PF_INET6, bind the local address to a randomly generated port number.

Member Data Documentation

Declare the dynamic allocation hooks.

Reimplemented from ACE_SOCK_IO.

Reimplemented in ACE_LSOCK_CODgram.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines