Groupsock Class Reference

#include <Groupsock.hh>

Inheritance diagram for Groupsock:

[legend]Collaboration diagram for Groupsock:

[legend]

Public Member Functions
	Groupsock (UsageEnvironment &env, struct in_addr const &groupAddr, Port port, u_int8_t ttl)
	Groupsock (UsageEnvironment &env, struct in_addr const &groupAddr, struct in_addr const &sourceFilterAddr, Port port)
virtual	~Groupsock ()
void	changeDestinationParameters (struct in_addr const &newDestAddr, Port newDestPort, int newDestTTL)
void	addDestination (struct in_addr const &addr, Port const &port)
void	removeDestination (struct in_addr const &addr, Port const &port)
void	removeAllDestinations ()
in_addr const &	groupAddress () const
in_addr const &	sourceFilterAddress () const
Boolean	isSSM () const
u_int8_t	ttl () const
void	multicastSendOnly ()
Boolean	output (UsageEnvironment &env, u_int8_t ttl, unsigned char *buffer, unsigned bufferSize, DirectedNetInterface *interfaceNotToFwdBackTo=NULL)
DirectedNetInterfaceSet &	members ()
Boolean	wasLoopedBackFromUs (UsageEnvironment &env, struct sockaddr_in &fromAddress)
virtual Boolean	handleRead (unsigned char *buffer, unsigned bufferMaxSize, unsigned &bytesRead, struct sockaddr_in &fromAddress)
Boolean	write (netAddressBits address, Port port, u_int8_t ttl, unsigned char *buffer, unsigned bufferSize)
int	socketNum () const
Port	port () const
UsageEnvironment &	env () const
Data Fields
Boolean	deleteIfNoMembers
Boolean	isSlave
NetInterfaceTrafficStats	statsGroupIncoming
NetInterfaceTrafficStats	statsGroupOutgoing
NetInterfaceTrafficStats	statsGroupRelayedIncoming
NetInterfaceTrafficStats	statsGroupRelayedOutgoing
Static Public Attributes
static NetInterfaceTrafficStats	statsIncoming
static NetInterfaceTrafficStats	statsOutgoing
static NetInterfaceTrafficStats	statsRelayedIncoming
static NetInterfaceTrafficStats	statsRelayedOutgoing
static int	DebugLevel = 1
static UsageEnvironment *	DefaultUsageEnvironment = NULL
Protected Member Functions
portNumBits	sourcePortNum () const
Boolean	changePort (Port newPort)
Private Member Functions
int	outputToAllMembersExcept (DirectedNetInterface *exceptInterface, u_int8_t ttlToFwd, unsigned char *data, unsigned size, netAddressBits sourceAddr)
Private Attributes
GroupEId	fIncomingGroupEId
destRecord *	fDests
u_int8_t	fTTL
DirectedNetInterfaceSet	fMembers

---

Detailed Description

Definition at line 78 of file Groupsock.hh.

---

Constructor & Destructor Documentation

Groupsock::Groupsock	(	UsageEnvironment &	env,
		struct in_addr const &	groupAddr,
		Port	port,
		u_int8_t	ttl
	)

Definition at line 102 of file Groupsock.cpp.

References addDestination(), Socket::DebugLevel, Socket::env(), UsageEnvironment::getResultMsg(), ourIPAddress(), Socket::port(), socketJoinGroup(), and Socket::socketNum().

  : OutputSocket(env, port),
    deleteIfNoMembers(False), isSlave(False),
    fIncomingGroupEId(groupAddr, port.num(), ttl), fDests(NULL), fTTL(ttl) {
  addDestination(groupAddr, port);

  if (!socketJoinGroup(env, socketNum(), groupAddr.s_addr)) {
    if (DebugLevel >= 1) {
      env << *this << ": failed to join group: "
          << env.getResultMsg() << "\n";
    }
  }

  // Make sure we can get our source address:
  if (ourIPAddress(env) == 0) {
    if (DebugLevel >= 0) { // this is a fatal error
      env << "Unable to determine our source address: "
          << env.getResultMsg() << "\n";
    }
  }

  if (DebugLevel >= 2) env << *this << ": created\n";
}

Groupsock::Groupsock	(	UsageEnvironment &	env,
		struct in_addr const &	groupAddr,
		struct in_addr const &	sourceFilterAddr,
		Port	port
	)

Definition at line 128 of file Groupsock.cpp.

References addDestination(), Socket::DebugLevel, Socket::env(), UsageEnvironment::getResultMsg(), Socket::port(), socketJoinGroup(), socketJoinGroupSSM(), and Socket::socketNum().

  : OutputSocket(env, port),
    deleteIfNoMembers(False), isSlave(False),
    fIncomingGroupEId(groupAddr, sourceFilterAddr, port.num()),
    fDests(NULL), fTTL(255) {
  addDestination(groupAddr, port);

  // First try a SSM join.  If that fails, try a regular join:
  if (!socketJoinGroupSSM(env, socketNum(), groupAddr.s_addr,
                          sourceFilterAddr.s_addr)) {
    if (DebugLevel >= 3) {
      env << *this << ": SSM join failed: "
          << env.getResultMsg();
      env << " - trying regular join instead\n";
    }
    if (!socketJoinGroup(env, socketNum(), groupAddr.s_addr)) {
      if (DebugLevel >= 1) {
        env << *this << ": failed to join group: "
             << env.getResultMsg() << "\n";
      }
    }
  }

  if (DebugLevel >= 2) env << *this << ": created\n";
}

Groupsock::~Groupsock

(

)

[virtual]

Definition at line 156 of file Groupsock.cpp.

References Socket::DebugLevel, Socket::env(), fDests, groupAddress(), isSSM(), socketLeaveGroup(), socketLeaveGroupSSM(), Socket::socketNum(), and sourceFilterAddress().

                      {
  if (isSSM()) {
    if (!socketLeaveGroupSSM(env(), socketNum(), groupAddress().s_addr,
                             sourceFilterAddress().s_addr)) {
      socketLeaveGroup(env(), socketNum(), groupAddress().s_addr);
    }
  } else {
    socketLeaveGroup(env(), socketNum(), groupAddress().s_addr);
  }

  delete fDests;

  if (DebugLevel >= 2) env() << *this << ": deleting\n";
}

---

Member Function Documentation

void Groupsock::changeDestinationParameters	(	struct in_addr const &	newDestAddr,
		Port	newDestPort,
		int	newDestTTL
	)

Definition at line 172 of file Groupsock.cpp.

References Socket::changePort(), Socket::env(), fDests, destRecord::fGroupEId, destRecord::fPort, GroupEId::groupAddress(), IsMulticastAddress(), NULL, Port::num(), GroupEId::portNum(), socketJoinGroup(), socketLeaveGroup(), Socket::socketNum(), and ttl().

Referenced by PassiveServerMediaSubsession::getStreamParameters(), MediaSubsession::initiate(), main(), SIPClient::processURL(), MediaSubsession::setDestinations(), and SIPClient::setProxyServer().

                                                                         {
  if (fDests == NULL) return;

  struct in_addr destAddr = fDests->fGroupEId.groupAddress();
  if (newDestAddr.s_addr != 0) {
    if (newDestAddr.s_addr != destAddr.s_addr
        && IsMulticastAddress(newDestAddr.s_addr)) {
      // If the new destination is a multicast address, then we assume that
      // we want to join it also.  (If this is not in fact the case, then
      // call "multicastSendOnly()" afterwards.)
      socketLeaveGroup(env(), socketNum(), destAddr.s_addr);
      socketJoinGroup(env(), socketNum(), newDestAddr.s_addr);
    }
    destAddr.s_addr = newDestAddr.s_addr;
  }

  portNumBits destPortNum = fDests->fGroupEId.portNum();
  if (newDestPort.num() != 0) {
    if (newDestPort.num() != destPortNum
        && IsMulticastAddress(destAddr.s_addr)) {
      // Also bind to the new port number:
      changePort(newDestPort);
      // And rejoin the multicast group:
      socketJoinGroup(env(), socketNum(), destAddr.s_addr);
    }
    destPortNum = newDestPort.num();
    fDests->fPort = newDestPort;
  }

  u_int8_t destTTL = ttl();
  if (newDestTTL != ~0) destTTL = (u_int8_t)newDestTTL;

  fDests->fGroupEId = GroupEId(destAddr, destPortNum, destTTL);
}

void Groupsock::addDestination	(	struct in_addr const &	addr,
		Port const &	port
	)

Definition at line 208 of file Groupsock.cpp.

References fDests, NULL, Port::num(), Socket::port(), and ttl().

Referenced by Groupsock(), and StreamState::startPlaying().

                                                                           {
  // Check whether this destination is already known:
  for (destRecord* dests = fDests; dests != NULL; dests = dests->fNext) {
    if (addr.s_addr == dests->fGroupEId.groupAddress().s_addr
        && port.num() == dests->fPort.num()) {
      return;
    }
  }

  fDests = new destRecord(addr, port, ttl(), fDests);
}

void Groupsock::removeDestination	(	struct in_addr const &	addr,
		Port const &	port
	)

Definition at line 220 of file Groupsock.cpp.

References fDests, NULL, Port::num(), and Socket::port().

Referenced by StreamState::endPlaying().

                                                                              {
  for (destRecord** destsPtr = &fDests; *destsPtr != NULL;
       destsPtr = &((*destsPtr)->fNext)) {
    if (addr.s_addr == (*destsPtr)->fGroupEId.groupAddress().s_addr
        && port.num() == (*destsPtr)->fPort.num()) {
      // Remove the record pointed to by *destsPtr :
      destRecord* next = (*destsPtr)->fNext;
      (*destsPtr)->fNext = NULL;
      delete (*destsPtr);
      *destsPtr = next;
      return;
    }
  }
}

void Groupsock::removeAllDestinations

(

)

Definition at line 235 of file Groupsock.cpp.

References fDests, and NULL.

Referenced by OnDemandServerMediaSubsession::getStreamParameters(), and RTPInterface::setStreamSocket().

                                      {
  delete fDests; fDests = NULL;
}

struct in_addr const& Groupsock::groupAddress

(

)

const [inline, read]

Definition at line 104 of file Groupsock.hh.

References fIncomingGroupEId, and GroupEId::groupAddress().

Referenced by PassiveServerMediaSubsession::getStreamParameters(), operator<<(), GroupsockLookupTable::Remove(), PassiveServerMediaSubsession::sdpLines(), and ~Groupsock().

                                             {
    return fIncomingGroupEId.groupAddress();
  }

struct in_addr const& Groupsock::sourceFilterAddress

(

)

const [inline, read]

Definition at line 107 of file Groupsock.hh.

References fIncomingGroupEId, and GroupEId::sourceFilterAddress().

Referenced by handleRead(), operator<<(), outputToAllMembersExcept(), GroupsockLookupTable::Remove(), and ~Groupsock().

                                                    {
    return fIncomingGroupEId.sourceFilterAddress();
  }

Boolean Groupsock::isSSM

(

)

const [inline]

Definition at line 111 of file Groupsock.hh.

References fIncomingGroupEId, and GroupEId::isSSM().

Referenced by handleRead(), operator<<(), outputToAllMembersExcept(), and ~Groupsock().

                        {
    return fIncomingGroupEId.isSSM();
  }

u_int8_t Groupsock::ttl

(

)

const [inline]

Definition at line 115 of file Groupsock.hh.

References fTTL.

Referenced by addDestination(), BasicUDPSink::afterGettingFrame1(), changeDestinationParameters(), PassiveServerMediaSubsession::getStreamParameters(), handleRead(), operator<<(), PassiveServerMediaSubsession::sdpLines(), and RTPInterface::sendPacket().

{ return fTTL; }

void Groupsock::multicastSendOnly

(

)

Definition at line 239 of file Groupsock.cpp.

References Socket::env(), fDests, fIncomingGroupEId, GroupEId::groupAddress(), NULL, socketLeaveGroup(), and Socket::socketNum().

Referenced by main(), and RTCPInstance::RTCPInstance().

                                  {
  socketLeaveGroup(env(), socketNum(), fIncomingGroupEId.groupAddress().s_addr);
  for (destRecord* dests = fDests; dests != NULL; dests = dests->fNext) {
    socketLeaveGroup(env(), socketNum(), dests->fGroupEId.groupAddress().s_addr);
  }
}

Boolean Groupsock::output	(	UsageEnvironment &	env,
		u_int8_t	ttl,
		unsigned char *	buffer,
		unsigned	bufferSize,
		DirectedNetInterface *	interfaceNotToFwdBackTo = NULL
	)

Definition at line 246 of file Groupsock.cpp.

References NetInterfaceTrafficStats::countPacket(), Socket::DebugLevel, Socket::env(), False, fDests, UsageEnvironment::getResultMsg(), members(), NULL, ourIPAddress(), outputToAllMembersExcept(), UsageEnvironment::setResultMsg(), statsGroupOutgoing, statsOutgoing, True, and OutputSocket::write().

Referenced by BasicUDPSink::afterGettingFrame1(), RTPInterface::sendPacket(), SIPClient::sendRequest(), and SIPClient::SIPClient().

                                                                         {
  do {
    // First, do the datagram send, to each destination:
    Boolean writeSuccess = True;
    for (destRecord* dests = fDests; dests != NULL; dests = dests->fNext) {
      if (!write(dests->fGroupEId.groupAddress().s_addr, dests->fPort, ttlToSend,
                 buffer, bufferSize)) {
        writeSuccess = False;
        break;
      }
    }
    if (!writeSuccess) break;
    statsOutgoing.countPacket(bufferSize);
    statsGroupOutgoing.countPacket(bufferSize);

    // Then, forward to our members:
    int numMembers = 0;
    if (!members().IsEmpty()) {
      numMembers =
        outputToAllMembersExcept(interfaceNotToFwdBackTo,
                                 ttlToSend, buffer, bufferSize,
                                 ourIPAddress(env));
      if (numMembers < 0) break;
    }

    if (DebugLevel >= 3) {
      env << *this << ": wrote " << bufferSize << " bytes, ttl "
          << (unsigned)ttlToSend;
      if (numMembers > 0) {
        env << "; relayed to " << numMembers << " members";
      }
      env << "\n";
    }
    return True;
  } while (0);

  if (DebugLevel >= 0) { // this is a fatal error
    env.setResultMsg("Groupsock write failed: ", env.getResultMsg());
  }
  return False;
}

DirectedNetInterfaceSet& Groupsock::members

(

)

[inline]

Definition at line 123 of file Groupsock.hh.

References fMembers.

Referenced by output(), and outputToAllMembersExcept().

{ return fMembers; }

Boolean Groupsock::wasLoopedBackFromUs	(	UsageEnvironment &	env,
		struct sockaddr_in &	fromAddress
	)

Definition at line 345 of file Groupsock.cpp.

References Socket::DebugLevel, Socket::env(), False, ourIPAddress(), OutputSocket::sourcePortNum(), and True.

Referenced by handleRead().

                                                                        {
  if (fromAddress.sin_addr.s_addr
      == ourIPAddress(env)) {
    if (fromAddress.sin_port == sourcePortNum()) {
#ifdef DEBUG_LOOPBACK_CHECKING
      if (DebugLevel >= 3) {
        env() << *this << ": got looped-back packet\n";
      }
#endif
      return True;
    }
  }

  return False;
}

Boolean Groupsock::handleRead	(	unsigned char *	buffer,
		unsigned	bufferMaxSize,
		unsigned &	bytesRead,
		struct sockaddr_in &	fromAddress
	)			[virtual]

Reimplemented from OutputSocket.

Definition at line 290 of file Groupsock.cpp.

References NetInterfaceTrafficStats::countPacket(), Socket::DebugLevel, Socket::env(), False, isSSM(), NULL, our_inet_ntoa(), outputToAllMembersExcept(), readSocket(), UsageEnvironment::setResultMsg(), Socket::socketNum(), sourceFilterAddress(), statsGroupIncoming, statsGroupRelayedIncoming, statsIncoming, statsRelayedIncoming, True, ttl(), TunnelEncapsulationTrailerMaxSize, and wasLoopedBackFromUs().

Referenced by SIPClient::getResponse(), SIPClient::getResponseCode(), RTPInterface::handleRead(), BasicUDPSource::incomingPacketHandler1(), and main().

                                                               {
  // Read data from the socket, and relay it across any attached tunnels
  //##### later make this code more general - independent of tunnels

  bytesRead = 0;

  int maxBytesToRead = bufferMaxSize - TunnelEncapsulationTrailerMaxSize;
  int numBytes = readSocket(env(), socketNum(),
                            buffer, maxBytesToRead, fromAddress);
  if (numBytes < 0) {
    if (DebugLevel >= 0) { // this is a fatal error
      env().setResultMsg("Groupsock read failed: ",
                         env().getResultMsg());
    }
    return False;
  }

  // If we're a SSM group, make sure the source address matches:
  if (isSSM()
      && fromAddress.sin_addr.s_addr != sourceFilterAddress().s_addr) {
    return True;
  }

  // We'll handle this data.
  // Also write it (with the encapsulation trailer) to each member,
  // unless the packet was originally sent by us to begin with.
  bytesRead = numBytes;

  int numMembers = 0;
  if (!wasLoopedBackFromUs(env(), fromAddress)) {
    statsIncoming.countPacket(numBytes);
    statsGroupIncoming.countPacket(numBytes);
    numMembers =
      outputToAllMembersExcept(NULL, ttl(),
                               buffer, bytesRead,
                               fromAddress.sin_addr.s_addr);
    if (numMembers > 0) {
      statsRelayedIncoming.countPacket(numBytes);
      statsGroupRelayedIncoming.countPacket(numBytes);
    }
  }
  if (DebugLevel >= 3) {
    env() << *this << ": read " << bytesRead << " bytes from ";
    env() << our_inet_ntoa(fromAddress.sin_addr);
    if (numMembers > 0) {
      env() << "; relayed to " << numMembers << " members";
    }
    env() << "\n";
  }

  return True;
}

int Groupsock::outputToAllMembersExcept	(	DirectedNetInterface *	exceptInterface,
		u_int8_t	ttlToFwd,
		unsigned char *	data,
		unsigned	size,
		netAddressBits	sourceAddr
	)			[private]

Definition at line 362 of file Groupsock.cpp.

References TunnelEncapsulationTrailer::address(), TunnelEncapsulationTrailer::auxAddress(), TunnelEncapsulationTrailer::command(), Socket::env(), fDests, destRecord::fGroupEId, destRecord::fPort, UsageEnvironment::getResultMsg(), GroupEId::groupAddress(), isSSM(), iter, members(), MediaSubsessionIterator::next(), NULL, TunnelEncapsulationTrailer::port(), DirectedNetInterface::SourceAddrOKForRelaying(), sourceFilterAddress(), TunnelEncapsulationTrailer::ttl(), TunnelDataAuxCmd, TunnelDataCmd, TunnelEncapsulationTrailerAuxSize, TunnelEncapsulationTrailerMaxSize, TunnelEncapsulationTrailerSize, and DirectedNetInterface::write().

Referenced by handleRead(), and output().

                                                                   {
  // Don't forward TTL-0 packets
  if (ttlToFwd == 0) return 0;

  DirectedNetInterfaceSet::Iterator iter(members());
  unsigned numMembers = 0;
  DirectedNetInterface* interf;
  while ((interf = iter.next()) != NULL) {
    // Check whether we've asked to exclude this interface:
    if (interf == exceptInterface)
      continue;

    // Check that the packet's source address makes it OK to
    // be relayed across this interface:
    UsageEnvironment& saveEnv = env();
    // because the following call may delete "this"
    if (!interf->SourceAddrOKForRelaying(saveEnv, sourceAddr)) {
      if (strcmp(saveEnv.getResultMsg(), "") != 0) {
                                // Treat this as a fatal error
        return -1;
      } else {
        continue;
      }
    }

    if (numMembers == 0) {
      // We know that we're going to forward to at least one
      // member, so fill in the tunnel encapsulation trailer.
      // (Note: Allow for it not being 4-byte-aligned.)
      TunnelEncapsulationTrailer* trailerInPacket
        = (TunnelEncapsulationTrailer*)&data[size];
      TunnelEncapsulationTrailer* trailer;

      Boolean misaligned = ((unsigned long)trailerInPacket & 3) != 0;
      unsigned trailerOffset;
      u_int8_t tunnelCmd;
      if (isSSM()) {
        // add an 'auxilliary address' before the trailer
        trailerOffset = TunnelEncapsulationTrailerAuxSize;
        tunnelCmd = TunnelDataAuxCmd;
      } else {
        trailerOffset = 0;
        tunnelCmd = TunnelDataCmd;
      }
      unsigned trailerSize = TunnelEncapsulationTrailerSize + trailerOffset;
      unsigned tmpTr[TunnelEncapsulationTrailerMaxSize];
      if (misaligned) {
        trailer = (TunnelEncapsulationTrailer*)&tmpTr;
      } else {
        trailer = trailerInPacket;
      }
      trailer += trailerOffset;

      if (fDests != NULL) {
        trailer->address() = fDests->fGroupEId.groupAddress().s_addr;
        trailer->port() = fDests->fPort; // structure copy, outputs in network order
      }
      trailer->ttl() = ttlToFwd;
      trailer->command() = tunnelCmd;

      if (isSSM()) {
        trailer->auxAddress() = sourceFilterAddress().s_addr;
      }

      if (misaligned) {
        memmove(trailerInPacket, trailer-trailerOffset, trailerSize);
      }

      size += trailerSize;
    }

    interf->write(data, size);
    ++numMembers;
  }

  return numMembers;
}

Boolean OutputSocket::write	(	netAddressBits	address,
		Port	port,
		u_int8_t	ttl,
		unsigned char *	buffer,
		unsigned	bufferSize
	)			[inherited]

Definition at line 45 of file Groupsock.cpp.

References Socket::DebugLevel, Socket::env(), False, OutputSocket::fLastSentTTL, OutputSocket::fSourcePort, UsageEnvironment::getResultMsg(), getSourcePort(), Socket::port(), Socket::socketNum(), OutputSocket::sourcePortNum(), True, and writeSocket().

Referenced by output().

                                                                        {
  if (ttl == fLastSentTTL) {
    // Optimization: So we don't do a 'set TTL' system call again
    ttl = 0;
  } else {
    fLastSentTTL = ttl;
  }
  struct in_addr destAddr; destAddr.s_addr = address;
  if (!writeSocket(env(), socketNum(), destAddr, port, ttl,
                   buffer, bufferSize))
    return False;

  if (sourcePortNum() == 0) {
    // Now that we've sent a packet, we can find out what the
    // kernel chose as our ephemeral source port number:
    if (!getSourcePort(env(), socketNum(), fSourcePort)) {
      if (DebugLevel >= 1)
        env() << *this
             << ": failed to get source port: "
             << env().getResultMsg() << "\n";
      return False;
    }
  }

  return True;
}

portNumBits OutputSocket::sourcePortNum

(

)

const [inline, protected, inherited]

Definition at line 50 of file Groupsock.hh.

References OutputSocket::fSourcePort, and Port::num().

Referenced by wasLoopedBackFromUs(), and OutputSocket::write().

{return fSourcePort.num();}

int Socket::socketNum

(

)

const [inline, inherited]

Definition at line 89 of file NetInterface.hh.

References Socket::fSocketNum.

Referenced by GroupsockLookupTable::AddNew(), BasicUDPSource::BasicUDPSource(), changeDestinationParameters(), continueAfterDESCRIBE(), BasicUDPSource::doGetNextFrame(), BasicUDPSource::doStopGettingFrames(), SocketLookupTable::Fetch(), OnDemandServerMediaSubsession::getStreamParameters(), Groupsock(), handleRead(), MediaSubsession::initiate(), SIPClient::invite1(), multicastSendOnly(), MultiFramedRTPSource::MultiFramedRTPSource(), operator<<(), RTPInterface::RTPInterface(), SIPClient::SIPClient(), RTPInterface::startNetworkReading(), PassiveServerMediaSubsession::startStream(), RTPInterface::stopNetworkReading(), unsetGroupsockBySocket(), OutputSocket::write(), BasicUDPSource::~BasicUDPSource(), and ~Groupsock().

{ return fSocketNum; }

Port Socket::port

(

)

const [inline, inherited]

Definition at line 91 of file NetInterface.hh.

References Socket::fPort.

Referenced by addDestination(), PassiveServerMediaSubsession::getStreamParameters(), Groupsock(), operator<<(), SocketLookupTable::Remove(), GroupsockLookupTable::Remove(), removeDestination(), PassiveServerMediaSubsession::sdpLines(), Socket::Socket(), and OutputSocket::write().

                    {
    return fPort;
  }

UsageEnvironment& Socket::env

(

)

const [inline, inherited]

Definition at line 95 of file NetInterface.hh.

References Socket::fEnv.

Referenced by changeDestinationParameters(), getGroupsockBySocket(), getSocketTable(), Groupsock(), handleRead(), multicastSendOnly(), output(), outputToAllMembersExcept(), setGroupsockBySocket(), socketReadHandler(), unsetGroupsockBySocket(), wasLoopedBackFromUs(), OutputSocket::write(), and ~Groupsock().

{ return fEnv; }

Boolean Socket::changePort

(

Port

newPort

)

[protected, inherited]

Definition at line 97 of file NetInterface.cpp.

References closeSocket, False, Socket::fEnv, Socket::fSocketNum, TaskScheduler::moveSocketHandling(), setupDatagramSocket(), UsageEnvironment::taskScheduler(), True, and TaskScheduler::turnOffBackgroundReadHandling().

Referenced by changeDestinationParameters().

                                       {
  int oldSocketNum = fSocketNum;
  closeSocket(fSocketNum);
  fSocketNum = setupDatagramSocket(fEnv, newPort);
  if (fSocketNum < 0) {
    fEnv.taskScheduler().turnOffBackgroundReadHandling(oldSocketNum);
    return False;
  }

  if (fSocketNum != oldSocketNum) { // the socket number has changed, so move any event handling for it:
    fEnv.taskScheduler().moveSocketHandling(oldSocketNum, fSocketNum);
  }
  return True;
}

---

Field Documentation

Boolean Groupsock::deleteIfNoMembers

Definition at line 125 of file Groupsock.hh.

Boolean Groupsock::isSlave

Definition at line 126 of file Groupsock.hh.

NetInterfaceTrafficStats Groupsock::statsIncoming [static]

Definition at line 128 of file Groupsock.hh.

Referenced by handleRead().

NetInterfaceTrafficStats Groupsock::statsOutgoing [static]

Definition at line 129 of file Groupsock.hh.

Referenced by output().

NetInterfaceTrafficStats Groupsock::statsRelayedIncoming [static]

Definition at line 130 of file Groupsock.hh.

Referenced by handleRead().

NetInterfaceTrafficStats Groupsock::statsRelayedOutgoing [static]

Definition at line 131 of file Groupsock.hh.

NetInterfaceTrafficStats Groupsock::statsGroupIncoming

Definition at line 132 of file Groupsock.hh.

Referenced by handleRead().

NetInterfaceTrafficStats Groupsock::statsGroupOutgoing

Definition at line 133 of file Groupsock.hh.

Referenced by output().

NetInterfaceTrafficStats Groupsock::statsGroupRelayedIncoming

Definition at line 134 of file Groupsock.hh.

Referenced by handleRead().

NetInterfaceTrafficStats Groupsock::statsGroupRelayedOutgoing

Definition at line 135 of file Groupsock.hh.

GroupEId Groupsock::fIncomingGroupEId [private]

Definition at line 152 of file Groupsock.hh.

Referenced by groupAddress(), isSSM(), multicastSendOnly(), and sourceFilterAddress().

destRecord* Groupsock::fDests [private]

Definition at line 153 of file Groupsock.hh.

Referenced by addDestination(), changeDestinationParameters(), multicastSendOnly(), output(), outputToAllMembersExcept(), removeAllDestinations(), removeDestination(), and ~Groupsock().

u_int8_t Groupsock::fTTL [private]

Definition at line 154 of file Groupsock.hh.

Referenced by ttl().

DirectedNetInterfaceSet Groupsock::fMembers [private]

Definition at line 155 of file Groupsock.hh.

Referenced by members().

int Socket::DebugLevel = 1 [static, inherited]

Definition at line 97 of file NetInterface.hh.

Referenced by Groupsock(), handleRead(), output(), wasLoopedBackFromUs(), OutputSocket::write(), and ~Groupsock().

UsageEnvironment * NetInterface::DefaultUsageEnvironment = NULL [static, inherited]

Definition at line 32 of file NetInterface.hh.

---

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

• groupsock/include/Groupsock.hh
• groupsock/Groupsock.cpp

---