OutputSocket Class Reference

#include <Groupsock.hh>

Inheritance diagram for OutputSocket:

[legend]Collaboration diagram for OutputSocket:

[legend]

Public Member Functions
	OutputSocket (UsageEnvironment &env)
virtual	~OutputSocket ()
Boolean	write (netAddressBits address, Port port, u_int8_t ttl, unsigned char *buffer, unsigned bufferSize)
int	socketNum () const
Port	port () const
UsageEnvironment &	env () const
Static Public Attributes
static int	DebugLevel = 1
static UsageEnvironment *	DefaultUsageEnvironment = NULL
Protected Member Functions
	OutputSocket (UsageEnvironment &env, Port port)
portNumBits	sourcePortNum () const
Boolean	changePort (Port newPort)
Private Member Functions
virtual Boolean	handleRead (unsigned char *buffer, unsigned bufferMaxSize, unsigned &bytesRead, struct sockaddr_in &fromAddress)
Private Attributes
Port	fSourcePort
u_int8_t	fLastSentTTL

---

Detailed Description

Definition at line 39 of file Groupsock.hh.

---

Constructor & Destructor Documentation

OutputSocket::OutputSocket

(

UsageEnvironment &

env

)

Definition at line 32 of file Groupsock.cpp.

  : Socket(env, 0 /* let kernel choose port */),
    fSourcePort(0), fLastSentTTL(0) {
}

OutputSocket::~OutputSocket

(

)

[virtual]

Definition at line 42 of file Groupsock.cpp.

                            {
}

OutputSocket::OutputSocket	(	UsageEnvironment &	env,
		Port	port
	)			[protected]

Definition at line 37 of file Groupsock.cpp.

  : Socket(env, port),
    fSourcePort(0), fLastSentTTL(0) {
}

---

Member Function Documentation

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

Definition at line 45 of file Groupsock.cpp.

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

Referenced by Groupsock::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]

Definition at line 50 of file Groupsock.hh.

References fSourcePort, and Port::num().

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

{return fSourcePort.num();}

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

Implements Socket.

Reimplemented in Groupsock.

Definition at line 75 of file Groupsock.cpp.

References True.

                                                                           {
  return True;
}

int Socket::socketNum

(

)

const [inline, inherited]

Definition at line 89 of file NetInterface.hh.

References Socket::fSocketNum.

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

{ return fSocketNum; }

Port Socket::port

(

)

const [inline, inherited]

Definition at line 91 of file NetInterface.hh.

References Socket::fPort.

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

                    {
    return fPort;
  }

UsageEnvironment& Socket::env

(

)

const [inline, inherited]

Definition at line 95 of file NetInterface.hh.

References Socket::fEnv.

Referenced by Groupsock::changeDestinationParameters(), getGroupsockBySocket(), getSocketTable(), Groupsock::Groupsock(), Groupsock::handleRead(), Groupsock::multicastSendOnly(), Groupsock::output(), Groupsock::outputToAllMembersExcept(), setGroupsockBySocket(), socketReadHandler(), unsetGroupsockBySocket(), Groupsock::wasLoopedBackFromUs(), write(), and Groupsock::~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 Groupsock::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

Port OutputSocket::fSourcePort [private]

Definition at line 58 of file Groupsock.hh.

Referenced by sourcePortNum(), and write().

u_int8_t OutputSocket::fLastSentTTL [private]

Definition at line 59 of file Groupsock.hh.

Referenced by write().

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

Definition at line 97 of file NetInterface.hh.

Referenced by Groupsock::Groupsock(), Groupsock::handleRead(), Groupsock::output(), Groupsock::wasLoopedBackFromUs(), write(), and Groupsock::~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

---