senf::INet4MulticastSocketProtocol Class Reference
[Protocol Facets]

Multicast protocol facet for INet4 addressable multicast enabled sockets. More...

#include <senf/Socket/Protocols/INet/MulticastSocketProtocol.hh>

Inheritance diagram for senf::INet4MulticastSocketProtocol:
Inheritance graph
[legend]

List of all members.

Detailed Description

Multicast protocol facet for INet4 addressable multicast enabled sockets.

Definition at line 83 of file MulticastSocketProtocol.hh.


Public Member Functions
void  mcAddMembership (INet4Address const &mcAddr) const
  Join multicast group on default interface.
void  mcAddMembership (INet4Address const &mcAddr, INet4Address const &localAddr) const
  join multicast group on a specific interface
void  mcAddMembership (INet4Address const &mcAddr, std::string const &iface) const
  join multicast group on a specific interface
void  mcDropMembership (INet4Address const &mcAddr) const
  Leave multicast group.
void  mcDropMembership (INet4Address const &mcAddr, INet4Address const &localAddr) const
  leave multicast group on a specific interface
void  mcDropMembership (INet4Address const &mcAddr, std::string const &iface) const
  leave multicast group on a specific interface
void  mcJoinSSMSource (INet4Address const &group, INet4Address const &source, std::string const &iface) const
  join SSM multicast group
void  mcLeaveSSMSource (INet4Address const &group, INet4Address const &source, std::string const &iface) const
  leave SSM multicast group

Member Function Documentation

void senf::INet4MulticastSocketProtocol::
mcAddMembership ( INet4Address const &  mcAddr,
std::string const &  iface )

join multicast group on a specific interface

This member will add mcAddr to the list of multicast groups received. The group is joined on the given interface.

Parameters:
[in]  mcAddr  address of group to join
[in]  iface  interface name

Definition at line 135 of file MulticastSocketProtocol.cc.

void senf::INet4MulticastSocketProtocol::
mcAddMembership ( INet4Address const &  mcAddr,
INet4Address const &  localAddr )

join multicast group on a specific interface

This member will add mcAddr to the list of multicast groups received. The group is joined on the interface with the given local address.

Deprecated:
Use mcAddMembership( mcAddr , iface ) for compatibility with the IPv6 API.
Parameters:
[in]  mcAddr  address of group to join
[in]  localAddr  address of interface to join on

Definition at line 123 of file MulticastSocketProtocol.cc.

void senf::INet4MulticastSocketProtocol::
mcAddMembership ( INet4Address const &  mcAddr )

Join multicast group on default interface.

This member will add mcAddr to the list of multicast groups received. The group is joined on the default interface.

Parameters:
[in]  mcAddr  address of group to join

Definition at line 112 of file MulticastSocketProtocol.cc.

void senf::INet4MulticastSocketProtocol::
mcDropMembership ( INet4Address const &  mcAddr,
std::string const &  iface )

leave multicast group on a specific interface

This member will remove mcAddr from the list of multicast groups received. The group is left from the interface with the given local address.

Parameters:
[in]  mcAddr  address of group to leave
[in]  iface  interface name

Definition at line 172 of file MulticastSocketProtocol.cc.

void senf::INet4MulticastSocketProtocol::
mcDropMembership ( INet4Address const &  mcAddr,
INet4Address const &  localAddr )

leave multicast group on a specific interface

This member will remove mcAddr from the list of multicast groups received. The group is left from the interface with the given local address.

Deprecated:
Use mcDropMembership( mcAddr , iface ) for compatibility with the IPv6 API.
Parameters:
[in]  mcAddr  address of group to leave
[in]  localAddr  address of interface to leave from

Definition at line 160 of file MulticastSocketProtocol.cc.

void senf::INet4MulticastSocketProtocol::
mcDropMembership ( INet4Address const &  mcAddr )

Leave multicast group.

This member will remove mcAddr from the list of multicast groups received. The group is left from the default interface.

Parameters:
[in]  mcAddr  address of group to leave

Definition at line 149 of file MulticastSocketProtocol.cc.

void senf::INet4MulticastSocketProtocol::
mcJoinSSMSource ( INet4Address const &  group,
INet4Address const &  source,
std::string const &  iface )

join SSM multicast group

This call will join the multicast group group for traffic from source. A single group may be joined multiple times on different sources.

Parameters:
[in]  group  multicast group to join
[in]  source  SSM multicast source to join the group on
[in]  iface  interface to join the group on

Definition at line 204 of file MulticastSocketProtocol.cc.

void senf::INet4MulticastSocketProtocol::
mcLeaveSSMSource ( INet4Address const &  group,
INet4Address const &  source,
std::string const &  iface )

leave SSM multicast group

This call will leave the multicast group group for traffic from source.

Parameters:
[in]  group  multicast group to leave
[in]  source  SSM multicast source to leave the group from
[in]  iface  interface to leave the group on

Definition at line 212 of file MulticastSocketProtocol.cc.

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