ACE_SOCK_Dgram Class Reference

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

#include <SOCK_Dgram.h>

Inheritance diagram for ACE_SOCK_Dgram:

[legend]Collaboration diagram for ACE_SOCK_Dgram:

[legend]List of all members.

Public Types
typedef ACE_INET_Addr	PEER_ADDR
Public Member Functions
	ACE_SOCK_Dgram (void)
	Default constructor.
	ACE_SOCK_Dgram (const ACE_Addr &local, int protocol_family=ACE_PROTOCOL_FAMILY_INET, int protocol=0, int reuse_addr=0)
	ACE_SOCK_Dgram (const ACE_Addr &local, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g=0, u_long flags=0, int reuse_addr=0)
int	open (const ACE_Addr &local, int protocol_family=ACE_PROTOCOL_FAMILY_INET, int protocol=0, int reuse_addr=0)
int	open (const ACE_Addr &local, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g=0, u_long flags=0, int reuse_addr=0)
	~ACE_SOCK_Dgram (void)
	Default dtor.
ssize_t	send (const void *buf, size_t n, const ACE_Addr &addr, int flags=0) const
	Send an byte to the datagram socket (uses <sendto(3)>).
ssize_t	recv (void *buf, size_t n, ACE_Addr &addr, int flags=0) const
ssize_t	recv (iovec *io_vec, ACE_Addr &addr, int flags=0, const ACE_Time_Value *timeout=0) const
ssize_t	send (const iovec iov[], int n, const ACE_Addr &addr, int flags=0) const
ssize_t	recv (iovec iov[], int n, ACE_Addr &addr, int flags=0) const
ssize_t	recv (void *buf, size_t n, ACE_Addr &addr, int flags, const ACE_Time_Value *timeout) const
ssize_t	send (const void *buf, size_t n, const ACE_Addr &addr, int flags, const ACE_Time_Value *timeout) const
ssize_t	send (const iovec buffers[], int buffer_count, size_t &number_of_bytes_sent, int flags, const ACE_Addr &addr, ACE_OVERLAPPED *overlapped, ACE_OVERLAPPED_COMPLETION_FUNC func) const
ssize_t	recv (iovec buffers[], int buffer_count, size_t &number_of_bytes_recvd, int &flags, ACE_Addr &addr, ACE_OVERLAPPED *overlapped, ACE_OVERLAPPED_COMPLETION_FUNC func) const
ssize_t	send (const void *buf, size_t n, const ACE_Addr &addr, int flags, ACE_OVERLAPPED *overlapped, ACE_OVERLAPPED_COMPLETION_FUNC func) const
	Send an byte to the datagram socket (uses ).
ssize_t	recv (void *buf, size_t n, ACE_Addr &addr, int flags, ACE_OVERLAPPED *overlapped, ACE_OVERLAPPED_COMPLETION_FUNC func) const
void	dump (void) const
	Dump the state of an object.
int	set_nic (const ACE_TCHAR *net_if, int addr_family=AF_UNSPEC)
	Set NIC to use as multicast interface.
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Protected Member Functions
int	shared_open (const ACE_Addr &local, int protocol_family)
	Open is shared by this and by .
int	make_multicast_ifaddr (ip_mreq *mreq, const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if)
int	make_multicast_ifaddr6 (ipv6_mreq *mreq, const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if)
Private Member Functions
int	get_remote_addr (ACE_Addr &) const
	Do not allow this function to percolate up to this interface...

---

Detailed Description

Defines the member functions for the ACE_SOCK datagram abstraction.

Definition at line 36 of file SOCK_Dgram.h.

---

Member Typedef Documentation

typedef ACE_INET_Addr ACE_SOCK_Dgram::PEER_ADDR

Definition at line 195 of file SOCK_Dgram.h.

---

Constructor & Destructor Documentation

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE ACE_SOCK_Dgram::ACE_SOCK_Dgram (  void   )

Default constructor. Definition at line 14 of file SOCK_Dgram.inl. References ACE_TRACE. { ACE_TRACE ("ACE_SOCK_Dgram::ACE_SOCK_Dgram"); }

ACE_SOCK_Dgram::ACE_SOCK_Dgram (  const ACE_Addr &  local, int  protocol_family = ACE_PROTOCOL_FAMILY_INET, int  protocol = 0, int  reuse_addr = 0 )

This is a BSD-style method (i.e., no QoS) for initiating a socket dgram that will accept datagrams at the address. Definition at line 215 of file SOCK_Dgram.cpp. References ACE_ERROR, ACE_LIB_TEXT, ACE_TRACE, LM_ERROR, and open(). { ACE_TRACE ("ACE_SOCK_Dgram::ACE_SOCK_Dgram"); if (this->open (local, protocol_family, protocol, reuse_addr) == -1) ACE_ERROR ((LM_ERROR, ACE_LIB_TEXT ("%p\n"), ACE_LIB_TEXT ("ACE_SOCK_Dgram"))); }

ACE_SOCK_Dgram::ACE_SOCK_Dgram (  const ACE_Addr &  local, int  protocol_family, int  protocol, ACE_Protocol_Info *  protocolinfo, ACE_SOCK_GROUP  g = 0, u_long  flags = 0, int  reuse_addr = 0 )

This is a QoS-enabed method for initiating a socket dgram that will accept datagrams at the address. The are passed to <ACE_OS::join_leaf>. Definition at line 231 of file SOCK_Dgram.cpp. References ACE_ERROR, ACE_LIB_TEXT, ACE_SOCK_GROUP, ACE_TRACE, LM_ERROR, and open(). { ACE_TRACE ("ACE_SOCK_Dgram::ACE_SOCK_Dgram"); if (this->open (local, protocol_family, protocol, protocolinfo, g, flags, reuse_addr) == -1) ACE_ERROR ((LM_ERROR, ACE_LIB_TEXT ("%p\n"), ACE_LIB_TEXT ("ACE_SOCK_Dgram"))); }

ACE_INLINE ACE_SOCK_Dgram::~ACE_SOCK_Dgram (  void   )

Default dtor. Definition at line 20 of file SOCK_Dgram.inl. References ACE_TRACE. { ACE_TRACE ("ACE_SOCK_Dgram::~ACE_SOCK_Dgram"); }

---

Member Function Documentation

ACE_BEGIN_VERSIONED_NAMESPACE_DECL void ACE_SOCK_Dgram::dump (  void   )  const

Dump the state of an object. Reimplemented from ACE_SOCK. Reimplemented in ACE_LSOCK_Dgram, ACE_SOCK_Dgram_Bcast, and ACE_SOCK_Dgram_Mcast. Definition at line 36 of file SOCK_Dgram.cpp. References ACE_TRACE. Referenced by ACE_LSOCK_Dgram::dump(). { #if defined (ACE_HAS_DUMP) ACE_TRACE ("ACE_SOCK_Dgram::dump"); #endif /* ACE_HAS_DUMP */ }

int ACE_SOCK_Dgram::get_remote_addr (  ACE_Addr &   )  const [private]

Do not allow this function to percolate up to this interface... Reimplemented from ACE_SOCK. Reimplemented in ACE_SOCK_Dgram_Bcast.

int ACE_SOCK_Dgram::make_multicast_ifaddr (  ip_mreq *  mreq, const ACE_INET_Addr &  mcast_addr, const ACE_TCHAR *  net_if )  [protected]

Create a multicast addr/if pair, in format useful for system calls. If mreq param is NULL, just verify the passed addr/interface specs. Definition at line 601 of file SOCK_Dgram.cpp. References ACE_HTONL, ACE_TCHAR, ACE_TEXT_ALWAYS_CHAR, ACE_TRACE, ACE_INET_Addr::get_ip_address(), ACE_INET_Addr::get_port_number(), ACE_OS::ioctl(), ACE_INET_Addr::set(), SIOCGIFADDR, and ACE_OS::strcpy(). Referenced by ACE_SOCK_Dgram_Mcast::join(), ACE_SOCK_Dgram_Mcast::leave(), set_nic(), ACE_SOCK_Dgram_Mcast::subscribe_i(), ACE_SOCK_Dgram_Mcast::subscribe_ifs(), and ACE_SOCK_Dgram_Mcast::unsubscribe_i(). { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::make_multicast_ifaddr"); ip_mreq lmreq; // Scratch copy. if (net_if != 0) { #if defined (ACE_WIN32) || defined(__INTERIX) // This port number is not necessary, just convenient ACE_INET_Addr interface_addr; if (interface_addr.set (mcast_addr.get_port_number (), net_if) == -1) return -1; lmreq.imr_interface.s_addr = ACE_HTONL (interface_addr.get_ip_address ()); #else ifreq if_address; ACE_OS::strcpy (if_address.ifr_name, ACE_TEXT_ALWAYS_CHAR (net_if)); if (ACE_OS::ioctl (this->get_handle (), SIOCGIFADDR, &if_address) == -1) return -1; sockaddr_in *socket_address; socket_address = reinterpret_cast<sockaddr_in*> (&if_address.ifr_addr); lmreq.imr_interface.s_addr = socket_address->sin_addr.s_addr; #endif /* ACE_WIN32 || __INTERIX */ } else lmreq.imr_interface.s_addr = INADDR_ANY; lmreq.IMR_MULTIADDR.s_addr = ACE_HTONL (mcast_addr.get_ip_address ()); // Set return info, if requested. if (ret_mreq) *ret_mreq = lmreq; return 0; }

int ACE_SOCK_Dgram::make_multicast_ifaddr6 (  ipv6_mreq *  mreq, const ACE_INET_Addr &  mcast_addr, const ACE_TCHAR *  net_if )  [protected]

Create a multicast addr/if pair, in format useful for system calls. If mreq param is NULL, just verify the passed addr/interface specs. Definition at line 647 of file SOCK_Dgram.cpp. References ACE_OS::ace_isdigit(), ACE_NEW_RETURN, ACE_TCHAR, ACE_TEXT_ALWAYS_CHAR, ACE_TRACE, ACE_OS::atoi(), ACE_INET_Addr::get_addr(), ACE_OS::memcpy(), ACE_OS::memset(), and ACE_OS::strcmp(). Referenced by set_nic(), ACE_SOCK_Dgram_Mcast::subscribe_i(), ACE_SOCK_Dgram_Mcast::subscribe_ifs(), and ACE_SOCK_Dgram_Mcast::unsubscribe_i(). { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::make_multicast_ifaddr6"); ipv6_mreq lmreq; // Scratch copy. ACE_OS::memset (&lmreq, 0, sizeof (lmreq)); #if defined(__linux__) if (net_if != 0) { lmreq.ipv6mr_interface = ACE_OS::if_nametoindex (ACE_TEXT_ALWAYS_CHAR(net_if)); } else #elif defined (ACE_WIN32) if (net_if != 0) { int if_ix = 0; bool num_if = ACE_OS::ace_isdigit (net_if[0]) && (if_ix = ACE_OS::atoi (net_if)) > 0; IP_ADAPTER_ADDRESSES tmp_addrs; // Initial call to determine actual memory size needed DWORD dwRetVal; ULONG bufLen = 0; if ((dwRetVal = ::GetAdaptersAddresses (AF_INET6, 0, NULL, &tmp_addrs, &bufLen)) != ERROR_BUFFER_OVERFLOW) return -1; // With output bufferlength 0 this can't be right. // Get required output buffer and retrieve info for real. PIP_ADAPTER_ADDRESSES pAddrs; char *buf; ACE_NEW_RETURN (buf, char[bufLen], -1); pAddrs = reinterpret_cast<PIP_ADAPTER_ADDRESSES> (buf); if ((dwRetVal = ::GetAdaptersAddresses (AF_INET6, 0, NULL, pAddrs, &bufLen)) != NO_ERROR) { delete[] buf; // clean up return -1; } lmreq.ipv6mr_interface = 0; // initialize while (pAddrs) { if ((num_if && pAddrs->Ipv6IfIndex == static_cast<unsigned int>(if_ix)) || (!num_if && (ACE_OS::strcmp (ACE_TEXT_ALWAYS_CHAR (net_if), pAddrs->AdapterName) == 0 || ACE_OS::strcmp (ACE_TEXT_ALWAYS_CHAR (net_if), ACE_Wide_To_Ascii (pAddrs->FriendlyName).char_rep()) == 0))) { lmreq.ipv6mr_interface = pAddrs->Ipv6IfIndex; break; } pAddrs = pAddrs->Next; } delete[] buf; // clean up } else #endif /* ACE_WIN32 */ lmreq.ipv6mr_interface = 0; // now set the multicast address ACE_OS::memcpy (&lmreq.ipv6mr_multiaddr, &((sockaddr_in6 *) mcast_addr.get_addr ())->sin6_addr, sizeof (in6_addr)); // Set return info, if requested. if (ret_mreq) *ret_mreq = lmreq; return 0; }

int ACE_SOCK_Dgram::open (  const ACE_Addr &  local, int  protocol_family, int  protocol, ACE_Protocol_Info *  protocolinfo, ACE_SOCK_GROUP  g = 0, u_long  flags = 0, int  reuse_addr = 0 )

This is a QoS-enabed method for initiating a socket dgram that will accept datagrams at the address. The are passed to <ACE_OS::join_leaf>. Definition at line 158 of file SOCK_Dgram.cpp. References ACE_SOCK_GROUP, ACE_SOCK::open(), and shared_open(). { if (ACE_SOCK::open (SOCK_DGRAM, protocol_family, protocol, protocolinfo, g, flags, reuse_addr) == -1) return -1; else if (this->shared_open (local, protocol_family) == -1) return -1; else return 0; }

int ACE_SOCK_Dgram::open (  const ACE_Addr &  local, int  protocol_family = ACE_PROTOCOL_FAMILY_INET, int  protocol = 0, int  reuse_addr = 0 )

This is a BSD-style method (i.e., no QoS) for initiating a socket dgram that will accept datagrams at the address. Definition at line 184 of file SOCK_Dgram.cpp. References ACE_TRACE, ACE_Addr::get_type(), ACE::ipv6_enabled(), ACE_SOCK::open(), and shared_open(). Referenced by ACE_SOCK_Dgram(), ACE_SOCK_Dgram_Bcast::open(), and ACE_LSOCK_Dgram::open(). { ACE_TRACE ("ACE_SOCK_Dgram::open"); if (local != ACE_Addr::sap_any) protocol_family = local.get_type (); else if (protocol_family == PF_UNSPEC) { #if defined (ACE_HAS_IPV6) protocol_family = ACE::ipv6_enabled () ? PF_INET6 : PF_INET; #else protocol_family = PF_INET; #endif /* ACE_HAS_IPV6 */ } if (ACE_SOCK::open (SOCK_DGRAM, protocol_family, protocol, reuse_addr) == -1) return -1; else return this->shared_open (local, protocol_family); }

ACE_INLINE ssize_t ACE_SOCK_Dgram::recv (  void *  buf, size_t  n, ACE_Addr &  addr, int  flags, ACE_OVERLAPPED *  overlapped, ACE_OVERLAPPED_COMPLETION_FUNC  func )  const

Receive an byte from the datagram socket (uses ). Definition at line 145 of file SOCK_Dgram.inl. References ACE_OVERLAPPED, ACE_OVERLAPPED_COMPLETION_FUNC, ACE_TRACE, iovec::iov_base, iovec::iov_len, and recv(). { ACE_TRACE ("ACE_SOCK_Dgram::recv"); iovec buffer[1]; buffer[0].iov_len = static_cast<u_long> (n); // Betting on < 4G buffer[0].iov_base = (char *) buf; size_t number_of_bytes_recvd = 0; return this->recv (buffer, 1, number_of_bytes_recvd, flags, addr, overlapped, func); }

ACE_INLINE ssize_t ACE_SOCK_Dgram::recv (  iovec  buffers[], int  buffer_count, size_t &  number_of_bytes_recvd, int &  flags, ACE_Addr &  addr, ACE_OVERLAPPED *  overlapped, ACE_OVERLAPPED_COMPLETION_FUNC  func )  const

Recv worth of from using overlapped I/O (uses ). Returns 0 on success. Definition at line 91 of file SOCK_Dgram.inl. References ACE_OVERLAPPED, ACE_OVERLAPPED_COMPLETION_FUNC, ACE_TRACE, ACE_Addr::get_addr(), ACE_Addr::get_size(), ACE_OS::recvfrom(), ACE_Addr::set_size(), ACE_Addr::set_type(), and ssize_t. { ACE_TRACE ("ACE_SOCK_Dgram::recv"); sockaddr *saddr = (sockaddr *) addr.get_addr (); int addr_len = addr.get_size (); ssize_t status = ACE_OS::recvfrom (this->get_handle (), buffers, buffer_count, number_of_bytes_recvd, flags, (sockaddr *) saddr, &addr_len, overlapped, func); addr.set_size (addr_len); addr.set_type (reinterpret_cast<sockaddr_in *> (saddr)->sin_family); return status; }

ssize_t ACE_SOCK_Dgram::recv (  void *  buf, size_t  n, ACE_Addr &  addr, int  flags, const ACE_Time_Value *  timeout )  const

Wait up to amount of time to receive a datagram into . The indicates how long to blocking trying to receive. If == 0, the caller will block until action is possible, else will wait until the relative time specified in * elapses). If times out a -1 is returned with <errno == ETIME>. If it succeeds the number of bytes received is returned. Definition at line 441 of file SOCK_Dgram.cpp. References ETIME, recv(), ACE_Handle_Set::reset(), ACE_OS::select(), and ACE_Handle_Set::set_bit(). { ACE_Handle_Set handle_set; handle_set.reset (); handle_set.set_bit (this->get_handle ()); // Check the status of the current socket. int select_width; #if defined (ACE_WIN32) // This arg is ignored on Windows and causes pointer truncation // warnings on 64-bit compiles. select_width = 0; #else select_width = int (this->get_handle ()) + 1; #endif /* ACE_WIN32 */ switch (ACE_OS::select (select_width, handle_set, 0, 0, timeout)) { case -1: return -1; /* NOTREACHED */ case 0: errno = ETIME; return -1; /* NOTREACHED */ default: // Goes fine, call <recv> to get data return this->recv (buf, n, addr, flags); } }

ssize_t ACE_SOCK_Dgram::recv (  iovec  iov[], int  n, ACE_Addr &  addr, int  flags = 0 )  const

Recv an of size to the datagram socket (uses <recvmsg(3)>). Definition at line 381 of file SOCK_Dgram.cpp. References ACE_NEW_RETURN, ACE_TRACE, iovec::iov_len, ACE_OS::memcpy(), recv(), and ssize_t. { ACE_TRACE ("ACE_SOCK_Dgram::recv"); ssize_t length = 0; int i; for (i = 0; i < n; i++) #if ! (defined(__BORLANDC__) && (__BORLANDC__ >= 0x0530)) // The iov_len is unsigned in Borland. If we go ahead and try the // if, it will emit a warning. if (iov[i].iov_len < 0) return -1; else #endif length += iov[i].iov_len; char *buf; #if defined (ACE_HAS_ALLOCA) buf = alloca (length); #else ACE_NEW_RETURN (buf, char[length], -1); #endif /* !defined (ACE_HAS_ALLOCA) */ length = ACE_SOCK_Dgram::recv (buf, length, addr, flags); if (length != -1) { char *ptr = buf; int copyn = length; for (i = 0; i < n && copyn > 0; i++) { ACE_OS::memcpy (iov[i].iov_base, ptr, // iov_len is int on some platforms, size_t on others copyn > (int) iov[i].iov_len ? (size_t) iov[i].iov_len : (size_t) copyn); ptr += iov[i].iov_len; copyn -= iov[i].iov_len; } } #if !defined (ACE_HAS_ALLOCA) delete [] buf; #endif /* !defined (ACE_HAS_ALLOCA) */ return length; }

ssize_t ACE_SOCK_Dgram::recv (  iovec *  io_vec, ACE_Addr &  addr, int  flags = 0, const ACE_Time_Value *  timeout = 0 )  const

Allows a client to read from a socket without having to provide a buffer to read. This method determines how much data is in the socket, allocates a buffer of this size, reads in the data, and returns the number of bytes read. The caller is responsible for deleting the member in the field of using the ``delete []'' syntax. Definition at line 49 of file SOCK_Dgram.cpp. References ACE_NEW_RETURN, ACE_NOTSUP_RETURN, ACE_TRACE, ETIME, ACE_Addr::get_addr(), ACE_Addr::get_size(), ACE_OS::ioctl(), iovec::iov_base, iovec::iov_len, ACE_OS::recvfrom(), ACE_Handle_Set::reset(), ACE_OS::select(), ACE_Handle_Set::set_bit(), and ACE_Addr::set_size(). { ACE_TRACE ("ACE_SOCK_Dgram::recv"); #if defined (FIONREAD) ACE_Handle_Set handle_set; handle_set.reset (); handle_set.set_bit (this->get_handle ()); // Check the status of the current socket to make sure there's data // to recv (or time out). int select_width; # if defined (ACE_WIN32) // This arg is ignored on Windows and causes pointer truncation // warnings on 64-bit compiles. select_width = 0; # else select_width = int (this->get_handle ()) + 1; # endif /* ACE_WIN32 */ switch (ACE_OS::select (select_width, handle_set, 0, 0, timeout)) { case -1: return -1; /* NOTREACHED */ case 0: errno = ETIME; return -1; /* NOTREACHED */ default: // Goes fine, fallthrough to get data break; } sockaddr *saddr = (sockaddr *) addr.get_addr (); int addr_len = addr.get_size (); int inlen; if (ACE_OS::ioctl (this->get_handle (), FIONREAD, &inlen) == -1) return -1; else if (inlen > 0) { ACE_NEW_RETURN (io_vec->iov_base, char[inlen], -1); io_vec->iov_len = ACE_OS::recvfrom (this->get_handle (), (char *) io_vec->iov_base, inlen, flags, (sockaddr *) saddr, &addr_len); addr.set_size (addr_len); return io_vec->iov_len; } else return 0; #else ACE_UNUSED_ARG (flags); ACE_UNUSED_ARG (addr); ACE_UNUSED_ARG (io_vec); ACE_UNUSED_ARG (timeout); ACE_NOTSUP_RETURN (-1); #endif /* FIONREAD */ }

ACE_INLINE ssize_t ACE_SOCK_Dgram::recv (  void *  buf, size_t  n, ACE_Addr &  addr, int  flags = 0 )  const

Receive an byte from the datagram socket (uses <recvfrom(3)>). Definition at line 47 of file SOCK_Dgram.inl. References ACE_TRACE, ACE_Addr::get_addr(), ACE_Addr::get_size(), ACE_OS::recvfrom(), ACE_Addr::set_size(), ACE_Addr::set_type(), and ssize_t. Referenced by recv(). { ACE_TRACE ("ACE_SOCK_Dgram::recv"); sockaddr *saddr = (sockaddr *) addr.get_addr (); int addr_len = addr.get_size (); ssize_t status = ACE_OS::recvfrom (this->get_handle (), (char *) buf, n, flags, (sockaddr *) saddr, &addr_len); addr.set_size (addr_len); addr.set_type (reinterpret_cast<sockaddr_in *> (saddr)->sin_family); return status; }

ACE_INLINE ssize_t ACE_SOCK_Dgram::send (  const void *  buf, size_t  n, const ACE_Addr &  addr, int  flags, ACE_OVERLAPPED *  overlapped, ACE_OVERLAPPED_COMPLETION_FUNC  func )  const

Send an byte to the datagram socket (uses ). Definition at line 120 of file SOCK_Dgram.inl. References ACE_OVERLAPPED, ACE_OVERLAPPED_COMPLETION_FUNC, ACE_TRACE, iovec::iov_base, iovec::iov_len, and send(). { ACE_TRACE ("ACE_SOCK_Dgram::send"); iovec buffer[1]; buffer[0].iov_len = static_cast<u_long> (n); // Betting on < 4G buffer[0].iov_base = (char *) buf; size_t number_of_bytes_sent = 0; return this->send (buffer, 1, number_of_bytes_sent, flags, addr, overlapped, func); }

ACE_INLINE ssize_t ACE_SOCK_Dgram::send (  const iovec  buffers[], int  buffer_count, size_t &  number_of_bytes_sent, int  flags, const ACE_Addr &  addr, ACE_OVERLAPPED *  overlapped, ACE_OVERLAPPED_COMPLETION_FUNC  func )  const

Send worth of to using overlapped I/O (uses ). Returns 0 on success. Definition at line 68 of file SOCK_Dgram.inl. References ACE_OVERLAPPED, ACE_OVERLAPPED_COMPLETION_FUNC, ACE_TRACE, ACE_Addr::get_addr(), ACE_Addr::get_size(), and ACE_OS::sendto(). { ACE_TRACE ("ACE_SOCK_Dgram::send"); sockaddr *saddr = (sockaddr *) addr.get_addr (); int len = addr.get_size (); return ACE_OS::sendto (this->get_handle (), buffers, buffer_count, number_of_bytes_sent, flags, (const sockaddr *) saddr, len, overlapped, func); }

ssize_t ACE_SOCK_Dgram::send (  const void *  buf, size_t  n, const ACE_Addr &  addr, int  flags, const ACE_Time_Value *  timeout )  const

Wait up to amount of time to send a datagram to . The indicates how long to blocking trying to receive. If == 0, the caller will block until action is possible, else will wait until the relative time specified in * elapses). If times out a -1 is returned with <errno == ETIME>. If it succeeds the number of bytes sent is returned. Definition at line 480 of file SOCK_Dgram.cpp. References ETIME, ACE_Handle_Set::reset(), ACE_OS::select(), send(), and ACE_Handle_Set::set_bit(). { ACE_Handle_Set handle_set; handle_set.reset (); handle_set.set_bit (this->get_handle ()); // Check the status of the current socket. int select_width; #if defined (ACE_WIN32) // This arg is ignored on Windows and causes pointer truncation // warnings on 64-bit compiles. select_width = 0; #else select_width = int (this->get_handle ()) + 1; #endif /* ACE_WIN32 */ switch (ACE_OS::select (select_width, 0, handle_set, 0, timeout)) { case -1: return -1; /* NOTREACHED */ case 0: errno = ETIME; return -1; /* NOTREACHED */ default: // Goes fine, call <send> to transmit the data. return this->send (buf, n, addr, flags); } }

ssize_t ACE_SOCK_Dgram::send (  const iovec  iov[], int  n, const ACE_Addr &  addr, int  flags = 0 )  const

Send an of size to the datagram socket (uses <sendmsg(3)>). Reimplemented in ACE_SOCK_Dgram_Bcast. Definition at line 331 of file SOCK_Dgram.cpp. References ACE_NEW_RETURN, ACE_TRACE, iovec::iov_len, ACE_OS::memcpy(), send(), and ssize_t. { ACE_TRACE ("ACE_SOCK_Dgram::send"); size_t length = 0; int i; // Determine the total length of all the buffers in <iov>. for (i = 0; i < n; i++) #if ! (defined(__BORLANDC__) && (__BORLANDC__ >= 0x0530)) // The iov_len is unsigned in Borland. If we go ahead and try the // if, it will emit a warning. if (iov[i].iov_len < 0) return -1; else #endif length += iov[i].iov_len; char *buf; #if defined (ACE_HAS_ALLOCA) buf = alloca (length); #else ACE_NEW_RETURN (buf, char[length], -1); #endif /* !defined (ACE_HAS_ALLOCA) */ char *ptr = buf; for (i = 0; i < n; i++) { ACE_OS::memcpy (ptr, iov[i].iov_base, iov[i].iov_len); ptr += iov[i].iov_len; } ssize_t result = ACE_SOCK_Dgram::send (buf, length, addr, flags); #if !defined (ACE_HAS_ALLOCA) delete [] buf; #endif /* !defined (ACE_HAS_ALLOCA) */ return result; }

ACE_INLINE ssize_t ACE_SOCK_Dgram::send (  const void *  buf, size_t  n, const ACE_Addr &  addr, int  flags = 0 )  const

Send an byte to the datagram socket (uses <sendto(3)>). Reimplemented in ACE_SOCK_Dgram_Bcast. Definition at line 28 of file SOCK_Dgram.inl. References ACE_TRACE, ACE_Addr::get_addr(), ACE_Addr::get_size(), and ACE_OS::sendto(). Referenced by ACE_SOCK_Dgram_Mcast::send(), ACE_SOCK_Dgram_Bcast::send(), and send(). { ACE_TRACE ("ACE_SOCK_Dgram::send"); sockaddr *saddr = (sockaddr *) addr.get_addr (); int len = addr.get_size (); return ACE_OS::sendto (this->get_handle (), (const char *) buf, n, flags, (struct sockaddr *) saddr, len); }

int ACE_SOCK_Dgram::set_nic (  const ACE_TCHAR *  net_if, int  addr_family = AF_UNSPEC )

Set NIC to use as multicast interface. Definition at line 519 of file SOCK_Dgram.cpp. References ACE_DEBUG, ACE_IPV6_ANY, ACE_LIB_TEXT, ACE_TCHAR, IP_MULTICAST_IF, LM_DEBUG, make_multicast_ifaddr(), make_multicast_ifaddr6(), ACE_INET_Addr::set(), and ACE_SOCK::set_option(). Referenced by ACE_SOCK_Dgram_Mcast::open_i(). { #if defined (IP_MULTICAST_IF) && (IP_MULTICAST_IF != 0) # if defined (ACE_HAS_IPV6) bool ipv6_mif_set = false; if (addr_family == AF_INET6 || addr_family == AF_UNSPEC) { ACE_INET_Addr addr; addr.set (static_cast<u_short> (0), ACE_IPV6_ANY); ipv6_mreq send_mreq; if (this->make_multicast_ifaddr6 (&send_mreq, addr, net_if) == -1) return -1; // Only let this attempt to set unknown interface when INET6 is // specifically requested. Otherwise we will just try INET. if (send_mreq.ipv6mr_interface != 0 || addr_family == AF_INET6) { if (this->ACE_SOCK::set_option (IPPROTO_IPV6, IPV6_MULTICAST_IF, &(send_mreq.ipv6mr_interface), sizeof send_mreq.ipv6mr_interface) == -1) return -1; } ipv6_mif_set = send_mreq.ipv6mr_interface != 0; } # if defined (ACE_WIN32) // For Win32 net_if is distintly different between INET6 and INET // so it is always either an INET6 if or an INET if. if (!ipv6_mif_set && (addr_family == AF_INET || addr_family == AF_UNSPEC)) # else if (addr_family == AF_INET || addr_family == AF_UNSPEC) # endif { ACE_INET_Addr addr (static_cast<u_short> (0)); ip_mreq send_mreq; if (this->make_multicast_ifaddr (&send_mreq, addr, net_if) == -1) { if (!ipv6_mif_set) return -1; } else if (this->ACE_SOCK::set_option (IPPROTO_IP, IP_MULTICAST_IF, &(send_mreq.imr_interface), sizeof send_mreq.imr_interface) == -1) { if (!ipv6_mif_set) return -1; } } # else /* ACE_HAS_IPV6 */ ACE_UNUSED_ARG (addr_family); ACE_INET_Addr addr (static_cast<u_short> (0)); ip_mreq send_mreq; if (this->make_multicast_ifaddr (&send_mreq, addr, net_if) == -1) return -1; if (this->ACE_SOCK::set_option (IPPROTO_IP, IP_MULTICAST_IF, &(send_mreq.imr_interface), sizeof send_mreq.imr_interface) == -1) return -1; # endif /* !ACE_HAS_IPV6 */ #else /* IP_MULTICAST_IF */ // Send interface option not supported - ignore it. // (We may have been invoked by ::subscribe, so we have to allow // a non-null interface parameter in this function.) ACE_DEBUG ((LM_DEBUG, ACE_LIB_TEXT ("Send interface specification not ") ACE_LIB_TEXT ("supported - IGNORED.\n"))); #endif /* !IP_MULTICAST_IF */ return 0; }

int ACE_SOCK_Dgram::shared_open (  const ACE_Addr &  local, int  protocol_family )  [protected]

Open is shared by this and by . Definition at line 126 of file SOCK_Dgram.cpp. References ACE_TRACE, ACE_OS::bind(), ACE::bind_port(), ACE_SOCK::close(), ACE_Addr::get_addr(), and ACE_Addr::get_size(). Referenced by open(), and ACE_SOCK_Dgram_Mcast::open_i(). { ACE_TRACE ("ACE_SOCK_Dgram::shared_open"); int error = 0; if (local == ACE_Addr::sap_any) { if (protocol_family == PF_INET #if defined (ACE_HAS_IPV6) || protocol_family == PF_INET6 #endif /* ACE_HAS_IPV6 */ ) { if (ACE::bind_port (this->get_handle (), INADDR_ANY, protocol_family) == -1) error = 1; } } else if (ACE_OS::bind (this->get_handle (), reinterpret_cast<sockaddr *> (local.get_addr ()), local.get_size ()) == -1) error = 1; if (error != 0) this->close (); return error ? -1 : 0; }

---

Member Data Documentation

ACE_SOCK_Dgram::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks. Reimplemented from ACE_SOCK. Reimplemented in ACE_LSOCK_Dgram, ACE_SOCK_Dgram_Bcast, and ACE_SOCK_Dgram_Mcast. Definition at line 205 of file SOCK_Dgram.h.

---

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

• SOCK_Dgram.h
• SOCK_Dgram.cpp
• SOCK_Dgram.inl

---