senf::MulticastSocketProtocol Class Reference
[Protocol Facets]

Generic addressing type independent multicast protocol facet. More...

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

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

List of all members.

Detailed Description

Generic addressing type independent multicast protocol facet.
Todo:
implement complete new multicast API from RFC3678 (as far as supported by linux)
Bug:
mcLeaveSSMSource fails with EADDRNOTAVAIL

Definition at line 47 of file MulticastSocketProtocol.hh.


Public Member Functions
void  broadcastEnabled (bool v) const
  Enable broadcast send/receive.
bool  broadcastEnabled () const
  Get broadcast send/receive state.
unsigned  mcTTL () const
  Return current multicast TTL.
void  mcTTL (unsigned value) const
  Set multicast TTL.
bool  mcLoop () const
  Return current multicast loopback state.
void  mcLoop (bool value) const
  Set multicast loopback state.
void  mcIface (std::string const &iface=std::string()) const
  Set multicast send interface of the socket.

Member Function Documentation

bool senf::MulticastSocketProtocol::
broadcastEnabled ()

Get broadcast send/receive state.

Returns:
Current state of the broadcastEnabled() option.

Definition at line 50 of file MulticastSocketProtocol.cc.

void senf::MulticastSocketProtocol::
broadcastEnabled ( bool  v )

Enable broadcast send/receive.

If this option is enabled, broadcast UDP messages will be received on the socket and the socket will be allowed to send out broadcast UDP messages

Parameters:
[in]  v  true to enable broadcast send/receive, false to disable

Definition at line 42 of file MulticastSocketProtocol.cc.

void senf::MulticastSocketProtocol::
mcIface ( std::string const &  iface = std::string() )

Set multicast send interface of the socket.

Parameters:
[in]  iface  name of interface to send multicast data from
Under current linux versions this option is broken at best. Don't use.

Definition at line 78 of file MulticastSocketProtocol.cc.

void senf::MulticastSocketProtocol::
mcLoop ( bool  value )

Set multicast loopback state.

If set to false via mcLoop(value) multicast messages will not be looped back to local sockets. Default value is true.

Definition at line 70 of file MulticastSocketProtocol.cc.

bool senf::MulticastSocketProtocol::
mcLoop ()

Return current multicast loopback state.

Definition at line 60 of file MulticastSocketProtocol.cc.

void senf::MulticastSocketProtocol::
mcTTL ( unsigned  value )

Set multicast TTL.

Definition at line 102 of file MulticastSocketProtocol.cc.

unsigned senf::MulticastSocketProtocol::
mcTTL ()

Return current multicast TTL.

Definition at line 92 of file MulticastSocketProtocol.cc.

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