Socket Class Reference

#include <NetInterface.hh>

Inheritance diagram for Socket:

[legend]Collaboration diagram for Socket:

[legend]

Public Member Functions
virtual	~Socket ()
virtual Boolean	handleRead (unsigned char *buffer, unsigned bufferMaxSize, unsigned &bytesRead, struct sockaddr_in &fromAddress)=0
int	socketNum () const
Port	port () const
UsageEnvironment &	env () const
Static Public Attributes
static int	DebugLevel = 1
static UsageEnvironment *	DefaultUsageEnvironment = NULL
Protected Member Functions
	Socket (UsageEnvironment &env, Port port)
Boolean	changePort (Port newPort)
Private Attributes
int	fSocketNum
UsageEnvironment &	fEnv
Port	fPort

---

Detailed Description

Definition at line 80 of file NetInterface.hh.

---

Constructor & Destructor Documentation

Socket::~Socket

(

)

[virtual]

Definition at line 93 of file NetInterface.cpp.

References closeSocket, and fSocketNum.

                {
  closeSocket(fSocketNum);
}

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

Definition at line 88 of file NetInterface.cpp.

References fEnv, fSocketNum, port(), and setupDatagramSocket().

  : fEnv(DefaultUsageEnvironment != NULL ? *DefaultUsageEnvironment : env), fPort(port) {
  fSocketNum = setupDatagramSocket(fEnv, port);
}

---

Member Function Documentation

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

Implemented in OutputSocket, and Groupsock.

Referenced by socketReadHandler().

int Socket::socketNum

(

)

const [inline]

Definition at line 89 of file NetInterface.hh.

References 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(), OutputSocket::write(), BasicUDPSource::~BasicUDPSource(), and Groupsock::~Groupsock().

{ return fSocketNum; }

Port Socket::port

(

)

const [inline]

Definition at line 91 of file NetInterface.hh.

References fPort.

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

                    {
    return fPort;
  }

UsageEnvironment& Socket::env

(

)

const [inline]

Definition at line 95 of file NetInterface.hh.

References fEnv.

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

{ return fEnv; }

Boolean Socket::changePort

(

Port

newPort

)

[protected]

Definition at line 97 of file NetInterface.cpp.

References closeSocket, False, fEnv, 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

int Socket::DebugLevel = 1 [static]

Definition at line 97 of file NetInterface.hh.

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

int Socket::fSocketNum [private]

Definition at line 105 of file NetInterface.hh.

Referenced by changePort(), Socket(), socketNum(), and ~Socket().

UsageEnvironment& Socket::fEnv [private]

Definition at line 106 of file NetInterface.hh.

Referenced by changePort(), env(), and Socket().

Port Socket::fPort [private]

Definition at line 107 of file NetInterface.hh.

Referenced by port().

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/NetInterface.hh
• groupsock/NetInterface.cpp

---