UsageEnvironment Class Reference

#include <UsageEnvironment.hh>

Inheritance diagram for UsageEnvironment:

[legend]Collaboration diagram for UsageEnvironment:

[legend]

Public Types
typedef char const *	MsgString
Public Member Functions
void	reclaim ()
TaskScheduler &	taskScheduler () const
virtual MsgString	getResultMsg () const=0
virtual void	setResultMsg (MsgString msg)=0
virtual void	setResultMsg (MsgString msg1, MsgString msg2)=0
virtual void	setResultMsg (MsgString msg1, MsgString msg2, MsgString msg3)=0
virtual void	setResultErrMsg (MsgString msg)=0
virtual void	appendToResultMsg (MsgString msg)=0
virtual void	reportBackgroundError ()=0
virtual int	getErrno () const=0
virtual UsageEnvironment &	operator<< (char const *str)=0
virtual UsageEnvironment &	operator<< (int i)=0
virtual UsageEnvironment &	operator<< (unsigned u)=0
virtual UsageEnvironment &	operator<< (double d)=0
virtual UsageEnvironment &	operator<< (void *p)=0
Data Fields
void *	liveMediaPriv
void *	groupsockPriv
Protected Member Functions
	UsageEnvironment (TaskScheduler &scheduler)
virtual	~UsageEnvironment ()
Private Attributes
TaskScheduler &	fScheduler

---

Detailed Description

Definition at line 49 of file UsageEnvironment.hh.

---

Member Typedef Documentation

typedef char const* UsageEnvironment::MsgString

Definition at line 57 of file UsageEnvironment.hh.

---

Constructor & Destructor Documentation

UsageEnvironment::UsageEnvironment

(

TaskScheduler &

scheduler

)

[protected]

Definition at line 27 of file UsageEnvironment.cpp.

  : liveMediaPriv(NULL), groupsockPriv(NULL), fScheduler(scheduler) {
}

UsageEnvironment::~UsageEnvironment

(

)

[protected, virtual]

Definition at line 31 of file UsageEnvironment.cpp.

                                    {
}

---

Member Function Documentation

void UsageEnvironment::reclaim

(

)

Definition at line 22 of file UsageEnvironment.cpp.

References groupsockPriv, liveMediaPriv, and NULL.

                               {
  // We delete ourselves only if we have no remainining state:
  if (liveMediaPriv == NULL && groupsockPriv == NULL) delete this;
}

TaskScheduler& UsageEnvironment::taskScheduler

(

)

const [inline]

Definition at line 54 of file UsageEnvironment.hh.

References fScheduler.

Referenced by BasicUDPSink::afterGettingFrame1(), MPEG4VideoFileServerMediaSubsession::afterPlayingDummy1(), awaitConfigInfo(), checkForAuxSDPLine(), MPEG4VideoFileServerMediaSubsession::checkForAuxSDPLine1(), checkForPacketArrival(), checkInterPacketGaps(), BasicUsageEnvironment::createNew(), SocketDescriptor::deregisterRTPInterface(), WAVAudioFileSource::doGetNextFrame(), MP3FileSource::doGetNextFrame(), ByteStreamFileSource::doGetNextFrame(), BasicUDPSource::doGetNextFrame(), AMRAudioFileSource::doGetNextFrame(), ADTSAudioFileSource::doGetNextFrame(), MultiFramedRTPSource::doGetNextFrame1(), SIPClient::doInviteStateMachine(), ByteStreamFileSource::doReadFromFile(), ByteStreamFileSource::doStopGettingFrames(), BasicUDPSource::doStopGettingFrames(), MPEG4VideoFileServerMediaSubsession::getAuxSDPLine(), getMPEG1or2TimeCode(), RTSPOverHTTPServer::HTTPClientConnection::HTTPClientConnection(), RTSPClient::incomingRequestHandler1(), SIPClient::invite1(), main(), RTSPServer::RTSPClientSession::noteLiveness(), RTSPClient::playMediaSession(), AC3AudioStreamParser::readAndSaveAFrame(), SocketDescriptor::registerRTPInterface(), RTCPInstance::reschedule(), RTSPServer::RTSPClientSession::RTSPClientSession(), RTSPOverHTTPServer::RTSPOverHTTPServer(), RTSPServer::RTSPServer(), RTCPInstance::schedule(), scheduleNextQOSMeasurement(), MultiFramedRTPSink::sendPacketIfNecessary(), shutdown(), RTPInterface::startNetworkReading(), startPlayingStreams(), RTPInterface::stopNetworkReading(), MediaSink::stopPlaying(), SocketDescriptor::tcpReadHandler(), waitUntilSocketIsReadable(), BasicUDPSource::~BasicUDPSource(), ByteStreamFileSource::~ByteStreamFileSource(), RTSPOverHTTPServer::HTTPClientConnection::~HTTPClientConnection(), Medium::~Medium(), RTSPClient::~RTSPClient(), RTSPServer::RTSPClientSession::~RTSPClientSession(), and RTSPServer::~RTSPServer().

{return fScheduler;}

virtual MsgString UsageEnvironment::getResultMsg

(

)

const [pure virtual]

Implemented in BasicUsageEnvironment0.

Referenced by Groupsock::Groupsock(), main(), Groupsock::output(), Groupsock::outputToAllMembersExcept(), play(), setupStreams(), SIPClient::SIPClient(), startPlayingStreams(), and OutputSocket::write().

virtual void UsageEnvironment::setResultMsg

(

MsgString

msg

)

[pure virtual]

Referenced by RTSPClient::announceSDPDescription(), QuickTimeFileSink::continuePlaying(), AVIFileSink::continuePlaying(), uLawFromPCMAudioSource::createNew(), MP3ADUTranscoder::createNew(), MP3FromADUSource::createNew(), ADUFromMP3Source::createNew(), AMRAudioFileSource::createNew(), ADTSAudioFileSource::createNew(), RTSPClient::describeURL(), MP3FileSource::doGetNextFrame1(), SIPClient::doInviteStateMachine(), RTPSource::getAttributes(), MP3FileSource::getAttributes(), MediaSource::getAttributes(), RTSPClient::getMediaSessionParameter(), getOptionsResponse(), SIPClient::getResponse(), RTSPClient::getResponse(), RTSPClient::getResponse1(), SIPClient::getResponseCode(), Groupsock::handleRead(), MP3FileSource::initializeStream(), MediaSession::initializeWithSDP(), MediaSubsession::initiate(), MediaSession::initiateByMediaType(), Medium::lookupByName(), Medium::Medium(), OpenInputFile(), OpenOutputFile(), ourIPAddress(), Groupsock::output(), SIPClient::parseResponseCode(), RTSPClient::parseResponseCode(), RTSPClient::parseRTSPURL(), SIPClient::parseSIPURL(), RTSPClient::pauseMediaSession(), RTSPClient::pauseMediaSubsession(), RTSPClient::playMediaSession(), RTSPClient::playMediaSubsession(), RTSPClient::recordMediaSubsession(), RTSPClient::sendOptionsCmd(), MediaSubsession::setClientPortNum(), setGroupsockBySocket(), RTSPClient::setMediaSessionParameter(), RTSPClient::setupHTTPTunneling(), RTSPClient::setupMediaSubsession(), QuickTimeFileSink::startPlaying(), MediaSink::startPlaying(), AVIFileSink::startPlaying(), RTSPClient::teardownMediaSession(), RTSPClient::teardownMediaSubsession(), and WAVAudioFileSource::WAVAudioFileSource().

virtual void UsageEnvironment::setResultMsg	(	MsgString	msg1,
		MsgString	msg2
	)			[pure virtual]

virtual void UsageEnvironment::setResultMsg	(	MsgString	msg1,
		MsgString	msg2,
		MsgString	msg3
	)			[pure virtual]

virtual void UsageEnvironment::setResultErrMsg

(

MsgString

msg

)

[pure virtual]

Referenced by HTTPSink::continuePlaying(), MP3HTTPSource::createNew(), RTSPClient::getResponse(), RTSPServer::incomingConnectionHandler1(), RTSPOverHTTPServer::incomingConnectionHandler1(), RTSPClient::incomingRequestHandler1(), RTSPClient::openConnectionFromURL(), ourIPAddress(), SIPClient::sendACK(), SIPClient::sendBYE(), SIPClient::sendINVITE(), RTSPClient::sendRequest(), RTSPClient::setupHTTPTunneling(), RTSPServer::setUpOurSocket(), RTSPOverHTTPServer::setUpOurSocket(), HTTPSink::setUpOurSocket(), and socketErr().

virtual void UsageEnvironment::appendToResultMsg

(

MsgString

msg

)

[pure virtual]

Referenced by HTTPSink::appendPortNum(), and MP3ADUTranscoder::getAttributes().

virtual void UsageEnvironment::reportBackgroundError

(

)

[pure virtual]

Implemented in BasicUsageEnvironment0.

Referenced by socketReadHandler().

virtual int UsageEnvironment::getErrno

(

)

const [pure virtual]

Implemented in BasicUsageEnvironment.

Referenced by HTTPSink::afterGettingFrame1(), HTTPSink::continuePlaying(), RTSPServer::incomingConnectionHandler1(), RTSPOverHTTPServer::incomingConnectionHandler1(), readSocket(), BasicUsageEnvironment0::setResultErrMsg(), QuickTimeFileSink::setWord(), AVIFileSink::setWord(), and socketJoinGroup().

virtual UsageEnvironment& UsageEnvironment::operator<<

(

char const *

str

)

[pure virtual]

Implemented in BasicUsageEnvironment.

virtual UsageEnvironment& UsageEnvironment::operator<<

(

int

i

)

[pure virtual]

Implemented in BasicUsageEnvironment.

virtual UsageEnvironment& UsageEnvironment::operator<<

(

unsigned

u

)

[pure virtual]

Implemented in BasicUsageEnvironment.

virtual UsageEnvironment& UsageEnvironment::operator<<

(

double

d

)

[pure virtual]

Implemented in BasicUsageEnvironment.

virtual UsageEnvironment& UsageEnvironment::operator<<

(

void *

p

)

[pure virtual]

Implemented in BasicUsageEnvironment.

---

Field Documentation

void* UsageEnvironment::liveMediaPriv

Definition at line 83 of file UsageEnvironment.hh.

Referenced by _Tables::getOurTables(), reclaim(), and _Tables::reclaimIfPossible().

void* UsageEnvironment::groupsockPriv

Definition at line 84 of file UsageEnvironment.hh.

Referenced by getSocketTable(), and reclaim().

TaskScheduler& UsageEnvironment::fScheduler [private]

Definition at line 91 of file UsageEnvironment.hh.

Referenced by taskScheduler().

---

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

• UsageEnvironment/include/UsageEnvironment.hh
• UsageEnvironment/UsageEnvironment.cpp

---