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

#include <SOCK_CODgram.h>

Inheritance diagram for ACE_SOCK_CODgram:

[legend]

Collaboration diagram for ACE_SOCK_CODgram:

Public Types
typedef ACE_INET_Addr	PEER_ADDR

Public Member Functions
	ACE_SOCK_CODgram (void)
	Default constructor. More...

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

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

Public Member Functions inherited from ACE_SOCK_IO
	ACE_SOCK_IO (void)
	Constructor. More...

	~ACE_SOCK_IO (void)
	Destructor. More...

ssize_t	recv (void buf, size_t n, int flags, const ACE_Time_Value timeout=0) const
	Recv an n byte buffer from the connected socket. More...

ssize_t	recv (void buf, size_t n, const ACE_Time_Value timeout=0) const
	Recv an n byte buffer from the connected socket. More...

ssize_t	recvv (iovec iov[], int n, const ACE_Time_Value *timeout=0) const
	Recv an <iovec> of size n from the connected socket. More...

ssize_t	recvv (iovec io_vec, const ACE_Time_Value timeout=0) const

ssize_t	recv (size_t n,...) const
	Recv n varargs messages to the connected socket. More...

ssize_t	recv (void buf, size_t n, ACE_OVERLAPPED overlapped) const
	Recv n bytes via Win32 `ReadFile` using overlapped I/O. More...

ssize_t	send (const void buf, size_t n, int flags, const ACE_Time_Value timeout=0) const
	Send an n byte buffer to the connected socket. More...

ssize_t	send (const void buf, size_t n, const ACE_Time_Value timeout=0) const
	Send an n byte buffer to the connected socket. More...

ssize_t	sendv (const iovec iov[], int n, const ACE_Time_Value *timeout=0) const
	Send an `iovec` of size n to the connected socket. More...

ssize_t	send (size_t n,...) const
	Send n varargs messages to the connected socket. More...

ssize_t	send (const void buf, size_t n, ACE_OVERLAPPED overlapped) const
	Send n bytes via Win32 <WriteFile> using overlapped I/O. More...

void	dump (void) const
	Dump the state of an object. More...

Public Member Functions inherited from ACE_SOCK
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_SOCK_IO
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Public Attributes inherited from ACE_SOCK
	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...

Additional Inherited Members
Protected Member Functions inherited from ACE_SOCK
	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

Defines the member functions for the ACE_SOCK connected datagram abstraction.

Member Typedef Documentation

typedef ACE_INET_Addr ACE_SOCK_CODgram::PEER_ADDR

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_sap	The remote address.
local_sap	The local address.
protocol_family	The 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.
protocol	Protocol value for the new socket.
reuse_addr	Reuse 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.

remote_addr == ACE_Addr::sap_any && local_addr != ACE_Addr::sap_any: Bind the local address (used primarily by servers).

remote_addr != ACE_Addr::sap_any && local_addr == ACE_Addr::sap_any: Connect to the remote address without binding a local address (used primarily by clients).

remote_addr != ACE_Addr::sap_any && local_addr != ACE_Addr::sap_any: Bind to the local address and connect to the remote address.

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.

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_sap	The remote address.
local_sap	The local address.
protocol_family	The 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.
protocol	Protocol value for the new socket.
reuse_addr	Reuse 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.

remote_addr == ACE_Addr::sap_any && local_addr != ACE_Addr::sap_any: Bind the local address (used primarily by servers).

remote_addr != ACE_Addr::sap_any && local_addr == ACE_Addr::sap_any: Connect to the remote address without binding a local address (used primarily by clients).

remote_addr != ACE_Addr::sap_any && local_addr != ACE_Addr::sap_any: Bind to the local address and connect to the remote address.

Member Data Documentation

ACE_SOCK_CODgram::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

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

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation