---

ACE_SOCK_Dgram_Mcast Class Reference

Defines the ACE socket wrapper for UDP/IP multicast. More...

#include <SOCK_Dgram_Mcast.h>

Inheritance diagram for ACE_SOCK_Dgram_Mcast:

[legend]Collaboration diagram for ACE_SOCK_Dgram_Mcast:

[legend]List of all members.

Public Types
enum	options {   OPT_BINDADDR_NO = 0, OPT_BINDADDR_YES = 1, DEFOPT_BINDADDR = OPT_BINDADDR_NO, OPT_NULLIFACE_ONE = 0,   OPT_NULLIFACE_ALL = 2, DEFOPT_NULLIFACE = OPT_NULLIFACE_ALL, DEFOPTS = DEFOPT_BINDADDR | DEFOPT_NULLIFACE }
	Option parameters. More...
Public Methods
	ACE_SOCK_Dgram_Mcast (options opts=DEFOPTS)
	Ctor - Create an unitialized instance and define per-instance optional functionality. More...
	~ACE_SOCK_Dgram_Mcast (void)
	Dtor - Release all resources and implicitly or explicitly unsubscribe from all currently subscribed groups. More...
int	open (const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if=0, int reuse_addr=1)
	Explicitly open/bind the socket and define the network interface and default multicast address used for sending messages. More...
int	subscribe (const ACE_INET_Addr &mcast_addr, int reuse_addr=1, const ACE_TCHAR *net_if=0, int protocol_family=PF_INET, int protocol=0)
	Join a multicast group on a given interface (or all interfaces, if supported). More...
int	join (const ACE_INET_Addr &mcast_addr, int reuse_addr=1, const ACE_TCHAR *net_if=0)
int	unsubscribe (const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if=0, int protocol_family=PF_INET, int protocol=0)
	Leave a multicast group on a given interface (or all interfaces, if supported). More...
int	leave (const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if=0)
int	unsubscribe (void)
	Unsubscribe all current subscriptions. More...
ssize_t	send (const void *buf, size_t n, int flags=0) const
	Send <n> bytes in <buf>, using the multicast address and network interface defined by the first <open> or <subscribe>. More...
ssize_t	send (const iovec iov[], int n, int flags=0) const
	Send <n> <iovecs>, using the multicast address and network interface defined by the first <open> or <subscribe>. More...
int	set_option (int option, char optval)
	Set a socket option. More...
void	dump (void) const
	Dump the state of an object. More...
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...
Protected Methods
int	open_i (const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if=0, int reuse_addr=1)
	Contains common open functionality so that inheriting classes can reuse it. More...
int	make_multicast_ifaddr (ip_mreq *mreq, const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if)
	Create a multicast addr/if pair, in format useful for system calls. If mreq param is NULL, just verify the passed addr/interface specs. More...
int	make_multicast_ifaddr_i (ip_mreq *mreq, const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if=ACE_LIB_TEXT("le0"))
	Create a multicast addr/if pair. This method factors out common code called by <make_multicast_address> and <subscribe>. More...
int	clear_subs_list (void)
	Empty the dynamic subscription list. More...
Private Methods
int	subscribe_ifs (const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if, int reuse_addr)
	Subscribe to a multicast address on one or more network interface(s). (No QoS support.). More...
int	subscribe_i (const ACE_INET_Addr &mcast_addr, int reuse_addr=1, const ACE_TCHAR *net_if=0)
	Do subscription processing w/out updating the subscription list. More...
int	unsubscribe_ifs (const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if=0)
	Unsubscribe from a multicast address on one or more network interface(s). More...
int	unsubscribe_i (const ACE_INET_Addr &mcast_addr, const ACE_TCHAR *net_if=0)
	Do unsubscription processing w/out udpating subscription list. More...
Private Attributes
int	opts_
	Per-instance options.. More...
ACE_INET_Addr	send_addr_
	Multicast address to which local <send> methods send datagrams. More...
ACE_TCHAR *	send_net_if_
	Network interface to which all <send> methods send multicast datagrams. More...

---

Detailed Description

Defines the ACE socket wrapper for UDP/IP multicast.

Supports multiple simultaneous subscriptions, unsubscription from one or all subscriptions, and independent send/recv address and interface specifications. Template parameters and/or ctor arguments determine per-instance optional functionality.

Note that multicast semantics and implementation details are _very_ environment-specific; this class is just a wrapper around the underlying implementation and does not try to normalize the concept of multicast communications.

Usage Notes:

• Send and Recv addresses and network interfaces, but not port#, are independent. While this instance is open, 1 send interface (and a default send address) is in effect and 0, 1, or multiple recv addresses/interfaces are in effect.
• The first <open>/<subscribe> invocation defines the network interface and default address used for all sends by this instance, defines the port# and optionally the multicast address bound to the underlying socket, and defines the (one) port# that is used for all subscribes (subsequent subscribes must pass the same port# or '0').
• The default loopback state is not explicitly set; the environment will determine the default state. Note that some environments (e.g. some Win32) do not allow the default to be changed, and that the semantics of loopback control are environment dependent (e.g. sender vs receiver control).
• In general, due to multicast design and implementation quirks/bugs, it is difficult to tell which address a received message was sent to or which interface it was received on (even if only one subscription is active). However; there are filtering options that can be applied, to narrow it down considerably.

Interface specification notes (for <subscribe> and <unsubscribe>):

• If net_if == 0, the null_iface_opt option determines whether only the system "default" interface or all interfaces is affected. Specifying "all" interfaces is supported only for environments for which <ACE_Sock_Connect::get_ip_interfaces> is properly implemented.
• Multiple subscriptions for the same address but different interfaces is normally supported, but re-subscription to an address/interface that is already subscribed is normally not allowed.
• The <net_if> interface specification syntax is environment-specific. UNIX systems will normally use device specifications such as "le0" or "elxl1", while other systems will use the IP address of the interface. Some platforms, such as pSoS, support only cardinal numbers as network interface specifications; for these platforms, just give these numbers in alphanumeric form and <subscribe> will convert them into numbers via <ACE_OS::atoi>.

Definition at line 90 of file SOCK_Dgram_Mcast.h.

---

Member Enumeration Documentation

enum ACE_SOCK_Dgram_Mcast::options

Option parameters. These control per-instance optional functionality. They are set via optional constructor arguments. Note: Certain option values are not valid for all environments (see comments in source file for environment-specific restrictions). Default values are always valid values for the compilation environment. Enumeration values: OPT_BINDADDR_NO  Disable address bind. (Bind only port.). OPT_BINDADDR_YES  Enable address bind. (Bind port and address.). DEFOPT_BINDADDR  Default value for BINDADDR option. (Environment-dependent.). OPT_NULLIFACE_ONE  If (net_if==NULL), use default interface. OPT_NULLIFACE_ALL  If (net_if==NULL), use all mcast interfaces. DEFOPT_NULLIFACE  Default value for NULLIFACE option. (Environment-dependent.). DEFOPTS  All default options. Definition at line 103 of file SOCK_Dgram_Mcast.h. Referenced by ACE_SOCK_Dgram_Mcast. { // Define whether a specific (multicast) address (in addition to the port#) // is bound to the socket. // Notes: // - Effect of doing this is stack/environment dependent, but in most // environments can be used to filter out unwanted unicast, broadcast, and // (other) multicast messages sent to the same port#. // - Some IP stacks (e.g. some Win32) do not support binding multicast // addresses. Using this option will always cause an <open> error. // - It's not strictly possible for user code to do this level of filtering // w/out the bind; some environments support ways to determine which address // a message was sent _to_, but this class interface does not support access // to that info. // - The address (and port#) passed to <open> (or the first <subscribe>, if // <open> is not explicitly invoked) is the one that is bound. // /// Disable address bind. (Bind only port.) // Note that this might seem odd, but we need a way to distinquish between // default behavior, which might or might not be to bind, and explicitely // choosing to bind or not to bind--which "is the question." ;-) OPT_BINDADDR_NO = 0, /// Enable address bind. (Bind port and address.) OPT_BINDADDR_YES = 1, /// Default value for BINDADDR option. (Environment-dependent.) #if defined (ACE_LACKS_PERFECT_MULTICAST_FILTERING) \ && (ACE_LACKS_PERFECT_MULTICAST_FILTERING == 1) // Platforms that don't support perfect filtering. Note that perfect // filtering only really applies to multicast traffic, not unicast // or broadcast. DEFOPT_BINDADDR = OPT_BINDADDR_YES, # else // At least some Win32 OS's can not bind mcast addr, so disable it. // General-purpose default behavior is 'disabled', since effect is // environment-specific and side-effects might be surprising. DEFOPT_BINDADDR = OPT_BINDADDR_NO, #endif /* ACE_LACKS_PERFECT_MULTICAST_FILTERING = 1) */ // /// Define the interpretation of 'NULL' as a recv interface specification. // If the interface part of a multicast address specification is NULL, it // will be interpreted to mean either "the default interface" or "all // interfaces", depending on the setting of this option. // Notes: // - The 'nulliface_all' option can not be used in environments which do // not fully support the <ACE_Sock_Connect::get_ip_interfaces> method // (e.g. non-Windows). // If it is, using NULL for iface will _always_ fail. // - The default behavior in most IP stacks is to use the 'default' interface, // where 'default' has rather ad-hoc semantics. // - This applies only to receives, not sends (which always use only one // interface; NULL means use the "system default" interface). // Supported values: /// If (net_if==NULL), use default interface. // Note that this might seem odd, but we need a way to distinquish between // default behavior, which might or might not be to bind, and explicitely // choosing to bind or not to bind--which "is the question." ;-) OPT_NULLIFACE_ONE = 0, /// If (net_if==NULL), use all mcast interfaces. OPT_NULLIFACE_ALL = 2, /// Default value for NULLIFACE option. (Environment-dependent.) #ifdef ACE_WIN32 // This is the (ad-hoc) legacy behavior for Win32/WinSock. // Notice: Older version of WinSock/MSVC may not get all multicast-capable // interfaces (e.g. PPP interfaces). DEFOPT_NULLIFACE = OPT_NULLIFACE_ALL, #else // General-purpose default behavior (as per legacy behavior). DEFOPT_NULLIFACE = OPT_NULLIFACE_ONE, #endif /* ACE_WIN32 */ /// All default options. DEFOPTS = DEFOPT_BINDADDR | DEFOPT_NULLIFACE };

---

Constructor & Destructor Documentation

ACE_SOCK_Dgram_Mcast::ACE_SOCK_Dgram_Mcast (  options    opts = DEFOPTS )

Ctor - Create an unitialized instance and define per-instance optional functionality. You must invoke <open> or <subscribe>, to create/bind a socket and define operational parameters, before performing any I/O with this instance. Definition at line 119 of file SOCK_Dgram_Mcast.cpp. References ACE_TRACE, and options. : opts_ (opts), send_net_if_ (0) { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::ACE_SOCK_Dgram_Mcast"); }

ACE_SOCK_Dgram_Mcast::~ACE_SOCK_Dgram_Mcast (  void    )

Dtor - Release all resources and implicitly or explicitly unsubscribe from all currently subscribed groups. The OPT_DTORUNSUB_YES_ option defines whether an explicit <unsusbcribe> is done by the destructor. If not, most systems will automatically unsubscribe upon the close of the socket. Definition at line 127 of file SOCK_Dgram_Mcast.cpp. References ACE_TRACE, clear_subs_list, and send_net_if_. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::~ACE_SOCK_Dgram_Mcast"); // Free memory and optionally unsubscribe from currently subscribed group(s). delete [] this->send_net_if_; this->clear_subs_list (); }

---

Member Function Documentation

int ACE_SOCK_Dgram_Mcast::clear_subs_list (  void    )  [protected]

Empty the dynamic subscription list. Definition at line 617 of file SOCK_Dgram_Mcast.cpp. References ACE_GUARD_RETURN, ACE_MT, and ACE_TRACE. Referenced by ~ACE_SOCK_Dgram_Mcast. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::clear_subs_list"); int result = 0; #if defined (ACE_SOCK_DGRAM_MCAST_DUMPABLE) ACE_MT (ACE_GUARD_RETURN (ACE_SDM_LOCK, guard, this->subscription_list_lock_, -1)); subscription_list_iter_t iter (this->subscription_list_); for (; !iter.done (); /*Hack: Do _not_ ::advance after remove*/) { ip_mreq *pm = iter.next (); iter.remove (); delete pm; } #endif /* ACE_SOCK_DGRAM_MCAST_DUMPABLE */ return result; }

void ACE_SOCK_Dgram_Mcast::dump (  void    )  const

Dump the state of an object. Logs the setting of all options, the bound address, the send address and interface, and the list of current subscriptions. Reimplemented from ACE_SOCK_Dgram. Definition at line 56 of file SOCK_Dgram_Mcast.cpp. References ACE_BEGIN_DUMP, ACE_BIT_ENABLED, ACE_DEBUG, ACE_END_DUMP, ACE_GUARD, ACE_LIB_TEXT, ACE_MT, ACE_NTOHL, ACE_TCHAR, ACE_TRACE, ACE_SDM_helpers::addr_to_string, ip_mreq::imr_interface, LM_DEBUG, MAXNAMELEN, OPT_BINDADDR_YES, OPT_NULLIFACE_ALL, ACE_OS_String::strcmp, and ACE_OS_String::strcpy. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::dump"); ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this)); # if defined (ACE_SOCK_DGRAM_MCAST_DUMPABLE) ACE_TCHAR addr_string[MAXNAMELEN + 1]; ACE_DEBUG ((LM_DEBUG, ACE_LIB_TEXT ("\nOptions: bindaddr=%s, nulliface=%s\n"), ACE_BIT_ENABLED (this->opts_, OPT_BINDADDR_YES) ? ACE_LIB_TEXT ("<Bound>") : ACE_LIB_TEXT ("<Not Bound>"), ACE_BIT_ENABLED (this->opts_, OPT_NULLIFACE_ALL) ? ACE_LIB_TEXT ("<All Ifaces>") : ACE_LIB_TEXT ("<Default Iface>"))); // Show default send addr, port#, and interface. ACE_SDM_helpers::addr_to_string (this->send_addr_, addr_string, sizeof addr_string, 0); ACE_DEBUG ((LM_DEBUG, ACE_LIB_TEXT ("Send addr=%s iface=%s\n"), addr_string, this->send_net_if_ ? this->send_net_if_ : ACE_LIB_TEXT ("<default>"))); // Show list of subscribed addresses. ACE_DEBUG ((LM_DEBUG, ACE_LIB_TEXT ("Subscription list:\n"))); ACE_MT (ACE_GUARD (ACE_SDM_LOCK, guard, this->subscription_list_lock_)); subscription_list_iter_t iter (this->subscription_list_); for ( ; !iter.done (); iter.advance ()) { ACE_TCHAR iface_string[MAXNAMELEN + 1]; ip_mreq *pm = iter.next (); // Get subscribed address (w/out port# info - not relevant). ACE_INET_Addr ip_addr (ACE_static_cast (u_short, 0), ACE_NTOHL (pm->IMR_MULTIADDR.s_addr)); ACE_SDM_helpers::addr_to_string (ip_addr, addr_string, sizeof addr_string, 1); // Get interface address/specification. ACE_INET_Addr if_addr (ACE_static_cast (u_short, 0), ACE_NTOHL (pm->imr_interface.s_addr)); ACE_SDM_helpers::addr_to_string (if_addr, iface_string, sizeof iface_string, 1); if (ACE_OS_String::strcmp (iface_string, ACE_LIB_TEXT ("0.0.0.0")) == 0) // Receives on system default iface. (Note that null_iface_opt_ // option processing has already occurred.) ACE_OS_String::strcpy (iface_string, ACE_LIB_TEXT ("<default>")); // Dump info. ACE_DEBUG ((LM_DEBUG, ACE_LIB_TEXT ("\taddr=%s iface=%s\n"), addr_string, iface_string)); } # endif /* ACE_SOCK_DGRAM_MCAST_DUMPABLE */ ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP)); }

int ACE_SOCK_Dgram_Mcast::join (  const ACE_INET_Addr &    mcast_addr, int    reuse_addr = 1, const ACE_TCHAR *    net_if = 0 )

Definition at line 325 of file SOCK_Dgram_Mcast.cpp. References ACE_BIT_ENABLED, ACE_ERROR, ACE_GUARD_RETURN, ACE_LIB_TEXT, ACE_MT, ACE_TCHAR, ACE_TRACE, ACE_SDM_helpers::addr_to_string, ENXIO, ACE_INET_Addr::get_ip_address, ACE_INET_Addr::get_port_number, LM_ERROR, make_multicast_ifaddr, MAXNAMELEN, OPT_BINDADDR_YES, send_addr_, ACE_INET_Addr::set_port_number, and subscribe_i. Referenced by subscribe. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::join"); ACE_INET_Addr subscribe_addr = mcast_addr; // If port# is 0, insert bound port# if it is set. (To satisfy lower-level // port# validation.) u_short def_port_number = this->send_addr_.get_port_number (); if (subscribe_addr.get_port_number () == 0 && def_port_number != 0) { subscribe_addr.set_port_number (def_port_number); } // Check for port# different than bound port#. u_short sub_port_number = mcast_addr.get_port_number (); if (sub_port_number != 0 && def_port_number != 0 && sub_port_number != def_port_number) { ACE_ERROR ((LM_ERROR, ACE_LIB_TEXT ("Subscribed port# (%u) different than bound ") ACE_LIB_TEXT ("port# (%u).\n"), (u_int) sub_port_number, (u_int) def_port_number)); errno = ENXIO; return -1; } // If bind_addr_opt_ is enabled, check for address different than // bound address. if (ACE_BIT_ENABLED (this->opts_, OPT_BINDADDR_YES) && this->send_addr_.get_ip_address () != INADDR_ANY && this->send_addr_.get_ip_address () != mcast_addr.get_ip_address ()) { ACE_TCHAR sub_addr_string[MAXNAMELEN + 1]; ACE_TCHAR bound_addr_string[MAXNAMELEN + 1]; ACE_SDM_helpers::addr_to_string (mcast_addr, sub_addr_string, sizeof sub_addr_string, 1); ACE_SDM_helpers::addr_to_string (this->send_addr_, bound_addr_string, sizeof bound_addr_string, 1); ACE_ERROR ((LM_ERROR, ACE_LIB_TEXT ("Subscribed address (%s) different than ") ACE_LIB_TEXT ("bound address (%s).\n"), sub_addr_string, bound_addr_string)); errno = ENXIO; return -1; } // Attempt subscription. int result = this->subscribe_i (subscribe_addr, reuse_addr, net_if); #if defined (ACE_SOCK_DGRAM_MCAST_DUMPABLE) if (result == 0) { // Add this addr/iface info to the list of subscriptions. // (Assumes this is unique addr/iface combo - most systems don't allow // re-sub to same addr/iface.) ip_mreq *pmreq = new ip_mreq; // (should not fail) if (this->make_multicast_ifaddr (pmreq, subscribe_addr, net_if) != -1) { ACE_MT (ACE_GUARD_RETURN (ACE_SDM_LOCK, guard, this->subscription_list_lock_, -1)); this->subscription_list_.insert_tail (pmreq); return 0; } // this still isn't really right. If ACE_GUARD_RETURN fails, we leak. // Need to add one of Chris' fancy ace auto pointers (bound?). delete pmreq; } #endif /* ACE_SOCK_DGRAM_MCAST_DUMPABLE */ return result >= 0 ? 0 : result; }

int ACE_SOCK_Dgram_Mcast::leave (  const ACE_INET_Addr &    mcast_addr, const ACE_TCHAR *    net_if = 0 )

Definition at line 527 of file SOCK_Dgram_Mcast.cpp. References ACE_GUARD_RETURN, ACE_MT, ACE_TCHAR, ACE_TRACE, ACE_SDM_helpers::is_equal, make_multicast_ifaddr, and unsubscribe_i. Referenced by unsubscribe, and unsubscribe_ifs. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::leave"); // Unsubscribe. int result = this->unsubscribe_i (mcast_addr, net_if); #if defined (ACE_SOCK_DGRAM_MCAST_DUMPABLE) // (Unconditionally) Remove this addr/if from subscription list. // (Addr/if is removed even if unsubscribe failed) ip_mreq tgt_mreq; if (this->make_multicast_ifaddr (&tgt_mreq, mcast_addr, net_if) != -1) { ACE_MT (ACE_GUARD_RETURN (ACE_SDM_LOCK, guard, this->subscription_list_lock_, -1)); subscription_list_iter_t iter (this->subscription_list_); for (; !iter.done (); iter.advance ()) { ip_mreq *pm = iter.next (); if (ACE_SDM_helpers::is_equal (*pm, tgt_mreq)) { iter.remove (); delete pm; break; } } } #endif /* ACE_SOCK_DGRAM_MCAST_DUMPABLE */ return result >= 0 ? 0 : result; }

int ACE_SOCK_Dgram_Mcast::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 637 of file SOCK_Dgram_Mcast.cpp. References ACE_HTONL, ACE_TCHAR, ACE_TRACE, ACE_OS::atoi, ACE_INET_Addr::get_ip_address, ACE_INET_Addr::get_port_number, ip_mreq::imr_interface, ACE_OS::ioctl, ACE_INET_Addr::set, SIOCGIFADDR, and ACE_OS_String::strcpy. Referenced by join, leave, open_i, subscribe_i, subscribe_ifs, and unsubscribe_i. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::make_multicast_ifaddr"); ip_mreq lmreq; // Scratch copy. if (net_if != 0) { #if defined (ACE_WIN32) // 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; #if defined (ACE_PSOS) // Look up the interface by number, not name. if_address.ifr_ifno = ACE_OS::atoi (net_if); #else ACE_OS_String::strcpy (if_address.ifr_name, net_if); #endif /* defined (ACE_PSOS) */ if (ACE_OS::ioctl (this->get_handle (), SIOCGIFADDR, &if_address) == -1) return -1; sockaddr_in *socket_address; socket_address = ACE_reinterpret_cast (sockaddr_in*, &if_address.ifr_addr); lmreq.imr_interface.s_addr = socket_address->sin_addr.s_addr; #endif /* ACE_WIN32 */ } 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_Mcast::make_multicast_ifaddr_i (  ip_mreq *    mreq, const ACE_INET_Addr &    mcast_addr, const ACE_TCHAR *    net_if = ACE_LIB_TEXT("le0") )  [protected]

Create a multicast addr/if pair. This method factors out common code called by <make_multicast_address> and <subscribe>.

int ACE_SOCK_Dgram_Mcast::open (  const ACE_INET_Addr &    mcast_addr, const ACE_TCHAR *    net_if = 0, int    reuse_addr = 1 )

Explicitly open/bind the socket and define the network interface and default multicast address used for sending messages. This method is optional; if not explicitly invoked, it is invoked by the first <subscribe>, using the subscribed address/port# and network interface paramters. The <mcast_addr> parameter defines the default send address/port# and also the port# and, if the OPT_BINDADDR_YES option is used, the multicast address that is bound to this socket. If the <send_net_if> parameter != 0, it defines the network interface used for all sends by this instance, otherwise the system "default" interface is used. (The <send_net_if> parameter is ignored if this feature is not supported by the envriornment.) The port# in <mcast_addr> may be 0, in which case a system-assigned (ephemeral) port# is used for sending and receiving. If <reuse_addr> != 0, the SO_REUSEADDR option and, if it is supported, the SO_REUSEPORT option are enabled. Returns: -1 if the call fails. Failure can occur due to problems with the address, port#, and/or interface parameters or during system open() or socket option processing. Definition at line 137 of file SOCK_Dgram_Mcast.cpp. References ACE_TCHAR, ACE_TRACE, ACE_IPC_SAP::get_handle, ACE_Addr::get_type, ACE_SOCK::open, and open_i. Referenced by subscribe_i. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::open"); // Only perform the <open> initialization if we haven't been opened // earlier. // No sanity check? We should probably flag an error if the user // makes multiple calls to open(). if (this->get_handle () != ACE_INVALID_HANDLE) return 0; // Invoke lower-layer ::open. if (ACE_SOCK::open (SOCK_DGRAM, mcast_addr.get_type (), 0, // always use 0 reuse_addr) == -1) return -1; return open_i (mcast_addr, net_if, reuse_addr); }

int ACE_SOCK_Dgram_Mcast::open_i (  const ACE_INET_Addr &    mcast_addr, const ACE_TCHAR *    net_if = 0, int    reuse_addr = 1 )  [protected]

Contains common open functionality so that inheriting classes can reuse it. Definition at line 161 of file SOCK_Dgram_Mcast.cpp. References ACE_BIT_DISABLED, ACE_DEBUG, ACE_LIB_TEXT, ACE_TCHAR, ACE_TRACE, ACE_SOCK::get_local_addr, ACE_INET_Addr::get_port_number, ACE_Addr::get_type, ip_mreq::imr_interface, IP_MULTICAST_IF, LM_DEBUG, make_multicast_ifaddr, OPT_BINDADDR_YES, send_addr_, send_net_if_, ACE_INET_Addr::set, ACE_SOCK::set_option, ACE_INET_Addr::set_port_number, ACE_SOCK_Dgram::shared_open, ACE_OS_String::strcpy, and ACE_OS_String::strlen. Referenced by open. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::open_i"); // ACE_SOCK::open calls this if reuse_addr is set, so we only need to // process port reuse option. if (reuse_addr) { #if defined (SO_REUSEPORT) int one = 1; if (this->ACE_SOCK::set_option (SOL_SOCKET, SO_REUSEPORT, &one, sizeof one) == -1) return -1; #endif /* SO_REUSEPORT */ } // Create an address/port# to bind the socket to. Use mcast_addr to // initialize bind_addy to pick up the correct protocol family. If // OPT_BINDADDR_YES is set, then we're done. Else use mcast_addr's // port number and use the "any" address. ACE_INET_Addr bind_addy (mcast_addr); if (ACE_BIT_DISABLED (this->opts_, OPT_BINDADDR_YES)) { // Bind to "any" address and explicit port#. if (bind_addy.set (mcast_addr.get_port_number ()) == -1) return -1; } // Bind to the address (which may be INADDR_ANY) and port# (which may be 0) if (ACE_SOCK_Dgram::shared_open (bind_addy, bind_addy.get_type ()) == -1) return -1; // Cache the actual bound address (which may be INADDR_ANY) // and the actual bound port# (which will be a valid, non-zero port#). ACE_INET_Addr bound_addy; if (this->get_local_addr (bound_addy) == -1) { // (Unexpected failure - should be bound to something) if (bound_addy.set (bind_addy) == -1) { // (Shouldn't happen - bind_addy is a valid addy; punt.) return -1; } } this->send_addr_ = mcast_addr; this->send_addr_.set_port_number (bound_addy.get_port_number ()); if (net_if) { #if defined (IP_MULTICAST_IF) && (IP_MULTICAST_IF != 0) ip_mreq send_mreq; if (this->make_multicast_ifaddr (&send_mreq, mcast_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; this->send_net_if_ = new ACE_TCHAR[ACE_OS_String::strlen (net_if) + 1]; ACE_OS_String::strcpy (this->send_net_if_, net_if); #else // 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; }

ASYS_INLINE ssize_t ACE_SOCK_Dgram_Mcast::send (  const iovec    iov[], int    n, int    flags = 0 )  const

Send <n> <iovecs>, using the multicast address and network interface defined by the first <open> or <subscribe>. Definition at line 38 of file SOCK_Dgram_Mcast.i. References ACE_TRACE, and ACE_SOCK_Dgram::send. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::send"); return this->ACE_SOCK_Dgram::send (iov, n, this->send_addr_, flags); }

ASYS_INLINE ssize_t ACE_SOCK_Dgram_Mcast::send (  const void *    buf, size_t    n, int    flags = 0 )  const

Send <n> bytes in <buf>, using the multicast address and network interface defined by the first <open> or <subscribe>. Definition at line 26 of file SOCK_Dgram_Mcast.i. References ACE_TRACE, and ACE_SOCK_Dgram::send. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::send"); return this->ACE_SOCK_Dgram::send (buf, n, this->send_addr_, flags); }

ASYS_INLINE int ACE_SOCK_Dgram_Mcast::set_option (  int    option, char    optval )

Set a socket option. Set an ip option that takes a char as input, such as <IP_MULTICAST_LOOP> or <IP_MULTICAST_TTL>. This is just a more concise, nice interface to a subset of possible <ACE_SOCK::set_option> calls, but only works for IPPROTO_IP or IPPROTO_IPV6 level options. Use <ACE_SOCK::set_option> directly to set anything else. Deprecated: { This method has been deprecated since it cannot be used easily with with IPv6 options.} Returns 0 on success, -1 on failure. Definition at line 5 of file SOCK_Dgram_Mcast.i. References ACE_TRACE, ACE_IPC_SAP::get_handle, ACE_Addr::get_type, send_addr_, and ACE_SOCK::set_option. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::set_option"); if (this->get_handle () == ACE_INVALID_HANDLE) return -1; int level = IPPROTO_IP; #if defined (IPPROTO_IPV6) if (this->send_addr_.get_type () == PF_INET6) level = IPPROTO_IPV6; #endif /* IPPROTO_IPV6 */ return this->ACE_SOCK::set_option (level, option, &optval, sizeof (optval)); }

int ACE_SOCK_Dgram_Mcast::subscribe (  const ACE_INET_Addr &    mcast_addr, int    reuse_addr = 1, const ACE_TCHAR *    net_if = 0, int    protocol_family = PF_INET, int    protocol = 0 )

Join a multicast group on a given interface (or all interfaces, if supported). The given group is joined on the specified interface. If option OPT_NULLIFACE_ALL is used and <net_if> is = 0, the group is joined on all multicast capable interfaces (IFF supported). Multiple subscriptions to various address and interface combinations are supported and tracked. If this is the first invocation of <subscribe>, and <open> was not previously invoked, <open> will be invoked using <mcast_addr> for binding the socket and <net_if> as the interface for <send>. Returns: -1 if the call fails. Failure can occur due to problems with the address, port#, and/or interface parameters or during the subscription attempt. Once bind() has been invoked (by the first <open> or <subscribe>), returns errno of ENXIO if the port# is not 0 and does not match the bound port#, or if OPT_BINDADDR_YES option is used and the address does not match the bound address. Returns errno of ENODEV if the addr/port#/interface parameters appeared valid, but no subscription(s) succeeded. An error is unconditionally returned if option OPT_NULLIFACE_ALL is used, <net_if> is NULL, and <ACE_Sock_Connect::get_ip_interfaces> is not implemented in this environment. Note that the optional <reuse_addr> parameter does not apply to subscriptions; it is only used if <open> is implicitly invoked (see above). NOTICE - This method has been deprecated, please use join() instead. In addition, the following paramters have also been deprecated: <protocol_family> and <protocol> have no effect. Definition at line 310 of file SOCK_Dgram_Mcast.cpp. References ACE_TCHAR, ACE_TRACE, and join. Referenced by subscribe_ifs. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::subscribe"); ACE_UNUSED_ARG (protocol_family); ACE_UNUSED_ARG (protocol); return this->join (mcast_addr,reuse_addr, net_if); }

int ACE_SOCK_Dgram_Mcast::subscribe_i (  const ACE_INET_Addr &    mcast_addr, int    reuse_addr = 1, const ACE_TCHAR *    net_if = 0 )  [private]

Do subscription processing w/out updating the subscription list. Definition at line 406 of file SOCK_Dgram_Mcast.cpp. References ACE_TCHAR, ACE_TRACE, IP_ADD_MEMBERSHIP, make_multicast_ifaddr, open, ACE_SOCK::set_option, and subscribe_ifs. Referenced by join. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::subscribe_i"); ip_mreq mreq; // Open the socket IFF this is the first ::subscribe and ::open // was not explicitly invoked. if (this->open (mcast_addr, net_if, reuse_addr) == -1) return -1; // Only do this if net_if == 0, i.e., INADDR_ANY if (net_if == 0) { int result = this->subscribe_ifs (mcast_addr, net_if, reuse_addr); // Check for error or "short-circuit" return. if (result != 0) return result; } // Create multicast addr/if struct. if (this->make_multicast_ifaddr (&mreq, mcast_addr, net_if) == -1) return -1; // Tell IP stack to pass messages sent to this group. // Note, this is not IPv6 compliant. else if (this->ACE_SOCK::set_option (IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof mreq) == -1) return -1; return 0; }

int ACE_SOCK_Dgram_Mcast::subscribe_ifs (  const ACE_INET_Addr &    mcast_addr, const ACE_TCHAR *    net_if, int    reuse_addr )  [private]

Subscribe to a multicast address on one or more network interface(s). (No QoS support.). Definition at line 240 of file SOCK_Dgram_Mcast.cpp. References ACE_BIT_ENABLED, ACE_LIB_TEXT, ACE_TCHAR, ACE_TEXT_CHAR_TO_TCHAR, ACE_TRACE, ACE_INET_Addr::get_ip_address, ACE_Sock_Connect::get_ip_interfaces, INADDR_LOOPBACK, make_multicast_ifaddr, OPT_NULLIFACE_ALL, and subscribe. Referenced by subscribe_i. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::subscribe_ifs"); if (ACE_BIT_ENABLED (this->opts_, OPT_NULLIFACE_ALL) && net_if == 0) { // Subscribe on all local multicast-capable network interfaces, by // doing recursive calls with specific interfaces. ACE_INET_Addr *if_addrs = 0; size_t if_cnt; if (ACE_Sock_Connect::get_ip_interfaces (if_cnt, if_addrs) != 0) return -1; size_t nr_subscribed = 0; if (if_cnt < 2) { if (this->subscribe (mcast_addr, reuse_addr, ACE_LIB_TEXT ("0.0.0.0")) == 0) ++nr_subscribed; } else { // Iterate through all the interfaces, figure out which ones // offer multicast service, and subscribe to them. while (if_cnt > 0) { --if_cnt; // Convert to 0-based for indexing, next loop check. if (if_addrs[if_cnt].get_ip_address () == INADDR_LOOPBACK) continue; if (this->subscribe (mcast_addr, reuse_addr, ACE_TEXT_CHAR_TO_TCHAR (if_addrs[if_cnt].get_host_addr ())) == 0) ++nr_subscribed; } } delete [] if_addrs; if (nr_subscribed == 0) { errno = ENODEV; return -1; } // 1 indicates a "short-circuit" return. This handles the // recursive behavior of checking all the interfaces. return 1; } // Validate passed multicast addr and iface specifications. if (this->make_multicast_ifaddr (0, mcast_addr, net_if) == -1) return -1; return 0; }

int ACE_SOCK_Dgram_Mcast::unsubscribe (  void    )

Unsubscribe all current subscriptions. Unsubscribe all active group/interface subscriptions (if any). Returns -1 if any unsubscribe failed, 0 if there are no errors or no current subscriptions. This method has been deprecated. Since a list of groups is not maintained (except when ACE_SOCK_DGRAM_MCAST_DUMPABLE is defined), it isn't possible to unsubscribe to all the groups without closing the socket. Therefore, if applications wish to unsubscribe to all groups without closing the socket, they much keep track of the subscriptions and call the above unsubscribe () for each. Definition at line 597 of file SOCK_Dgram_Mcast.cpp. References ACE_ERROR_RETURN, ACE_LIB_TEXT, ACE_TRACE, and LM_INFO. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::unsubscribe"); // Can't implement this reliably without keeping an expensive list, // and can't close the socket since the caller may want to continue // using the socket to send() or join() new groups. Even if we // wanted to be clever and reopen the socket, we'd need to know what // options had been set, and reset them--and we have no way of doing // that either. :-( // Should this return -1? ACE_ERROR_RETURN ((LM_INFO, ACE_LIB_TEXT ("ACE_SOCK_Dgram_Mcast::unsubscribe (void) ") ACE_LIB_TEXT ("has been deprecated. You must either ") ACE_LIB_TEXT ("close to socket to unsubscribe to all ") ACE_LIB_TEXT ("or unsubscribe to each individually.\n")), 0); }

int ACE_SOCK_Dgram_Mcast::unsubscribe (  const ACE_INET_Addr &    mcast_addr, const ACE_TCHAR *    net_if = 0, int    protocol_family = PF_INET, int    protocol = 0 )

Leave a multicast group on a given interface (or all interfaces, if supported). The specified group/interface combination is unsubscribed. If option OPT_NULLIFACE_ALL is used and <net_if> is = 0, the group is unsubscribed from all interfaces (IFF supported). Returns: -1 if the unsubscribe failed. Most environments will return -1 if there was no active subscription for this address/interface combination. An error is unconditionally returned if option OPT_NULLIFACE_ALL is used, <net_if> is = 0, and <ACE_Sock_Connect::get_ip_interfaces> is not implemented in this environment (_even if_ the <subscribe> specifies a non- NULL <net_if>). NOTICE - This method has been deprecated. Please use leave() instead. In addition, <protocol_family> and <protocol> have no effect. Definition at line 513 of file SOCK_Dgram_Mcast.cpp. References ACE_TCHAR, ACE_TRACE, and leave. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::unsubscribe"); ACE_UNUSED_ARG (protocol_family); ACE_UNUSED_ARG (protocol); return this->leave (mcast_addr, net_if); }

int ACE_SOCK_Dgram_Mcast::unsubscribe_i (  const ACE_INET_Addr &    mcast_addr, const ACE_TCHAR *    net_if = 0 )  [private]

Do unsubscription processing w/out udpating subscription list. Definition at line 564 of file SOCK_Dgram_Mcast.cpp. References ACE_TCHAR, ACE_TRACE, IP_DROP_MEMBERSHIP, make_multicast_ifaddr, ACE_SOCK::set_option, and unsubscribe_ifs. Referenced by leave. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::unsubscribe_i"); int result = this->unsubscribe_ifs (mcast_addr, net_if); // Check for error or "short-circuit" return. if (result != 0) return result; // Validate addr/if specifications and create addr/if struct. ip_mreq mreq; if (this->make_multicast_ifaddr (&mreq, mcast_addr, net_if) == -1) { return -1; } // Tell network device driver to stop reading datagrams with the // <mcast_addr>. // Note, this is not IPv6 friendly... else if (ACE_SOCK::set_option (IPPROTO_IP, IP_DROP_MEMBERSHIP, &mreq, sizeof mreq) == -1) { return -1; } return 0; }

int ACE_SOCK_Dgram_Mcast::unsubscribe_ifs (  const ACE_INET_Addr &    mcast_addr, const ACE_TCHAR *    net_if = 0 )  [private]

Unsubscribe from a multicast address on one or more network interface(s). Definition at line 447 of file SOCK_Dgram_Mcast.cpp. References ACE_BIT_ENABLED, ACE_LIB_TEXT, ACE_TCHAR, ACE_TEXT_CHAR_TO_TCHAR, ACE_TRACE, ACE_INET_Addr::get_ip_address, ACE_Sock_Connect::get_ip_interfaces, INADDR_LOOPBACK, leave, and OPT_NULLIFACE_ALL. Referenced by unsubscribe_i. { ACE_TRACE ("ACE_SOCK_Dgram_Mcast::unsubscribe_ifs"); if (ACE_BIT_ENABLED (this->opts_, OPT_NULLIFACE_ALL) && net_if == 0) { // Unsubscribe on all local multicast-capable network interfaces, by // doing recursive calls with specific interfaces. ACE_INET_Addr *if_addrs = 0; size_t if_cnt; // NOTE - <get_ip_interfaces> doesn't always get all of the // interfaces. In particular, it may not get a PPP interface. This // is a limitation of the way <get_ip_interfaces> works with // old versions of MSVC. The reliable way of getting the interface list // is available only with MSVC 5 and newer. if (ACE_Sock_Connect::get_ip_interfaces (if_cnt, if_addrs) != 0) return -1; size_t nr_unsubscribed = 0; if (if_cnt < 2) { if (this->leave (mcast_addr, ACE_LIB_TEXT ("0.0.0.0")) == 0) ++nr_unsubscribed; } else { while (if_cnt > 0) { --if_cnt; // Convert to 0-based for indexing, next loop check if (if_addrs[if_cnt].get_ip_address () == INADDR_LOOPBACK) continue; if (this->leave (mcast_addr, ACE_TEXT_CHAR_TO_TCHAR (if_addrs[if_cnt].get_host_addr ())) == 0) ++nr_unsubscribed; } } delete [] if_addrs; if (nr_unsubscribed == 0) { errno = ENODEV; return -1; } return 1; } return 0; }

---

Member Data Documentation

ACE_SOCK_Dgram_Mcast::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks. Reimplemented from ACE_SOCK_Dgram. Definition at line 347 of file SOCK_Dgram_Mcast.h.

int ACE_SOCK_Dgram_Mcast::opts_ [private]

Per-instance options.. Definition at line 398 of file SOCK_Dgram_Mcast.h.

ACE_INET_Addr ACE_SOCK_Dgram_Mcast::send_addr_ [private]

Multicast address to which local <send> methods send datagrams. Definition at line 401 of file SOCK_Dgram_Mcast.h. Referenced by join, open_i, and set_option.

ACE_TCHAR* ACE_SOCK_Dgram_Mcast::send_net_if_ [private]

Network interface to which all <send> methods send multicast datagrams. Definition at line 403 of file SOCK_Dgram_Mcast.h. Referenced by open_i, and ~ACE_SOCK_Dgram_Mcast.

---

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

• SOCK_Dgram_Mcast.h
• SOCK_Dgram_Mcast.cpp
• SOCK_Dgram_Mcast.i

---