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, int err=0)=0
virtual void	appendToResultMsg (MsgString msg)=0
virtual void	reportBackgroundError ()=0
virtual void	internalError ()
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 53 of file UsageEnvironment.hh.

---

Member Typedef Documentation

typedef char const* UsageEnvironment::MsgString

Definition at line 61 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 58 of file UsageEnvironment.hh.

References fScheduler.

Referenced by RTCPInstance::addStreamSocket(), T140IdleFilter::afterGettingFrame(), BasicUDPSink::afterGettingFrame1(), MPEG4VideoFileServerMediaSubsession::afterPlayingDummy1(), H264VideoFileServerMediaSubsession::afterPlayingDummy1(), awaitConfigInfo(), RTSPServer::RTSPClientConnection::changeClientInputSocket(), Socket::changePort(), checkForAuxSDPLine(), MPEG4VideoFileServerMediaSubsession::checkForAuxSDPLine1(), H264VideoFileServerMediaSubsession::checkForAuxSDPLine1(), checkForPacketArrival(), checkInterPacketGaps(), RTSPServer::RTSPClientConnection::closeSockets(), RTSPClient::connectionHandler1(), RTSPClient::connectToServer(), continueAfterPLAY(), ProxyRTSPClient::continueAfterSETUP(), BasicUsageEnvironment::createNew(), createNewSMS(), DeviceSource::DeviceSource(), WAVAudioFileSource::doGetNextFrame(), T140IdleFilter::doGetNextFrame(), MPEG2TransportStreamMultiplexor::doGetNextFrame(), MP3FileSource::doGetNextFrame(), ByteStreamFileSource::doGetNextFrame(), BasicUDPSource::doGetNextFrame(), AMRAudioFileSource::doGetNextFrame(), ADTSAudioFileSource::doGetNextFrame(), MultiFramedRTPSource::doGetNextFrame1(), SIPClient::doInviteStateMachine(), WAVAudioFileSource::doReadFromFile(), ByteStreamFileSource::doReadFromFile(), WAVAudioFileSource::doStopGettingFrames(), T140IdleFilter::doStopGettingFrames(), MultiFramedRTPSource::doStopGettingFrames(), FramedSource::doStopGettingFrames(), ByteStreamFileSource::doStopGettingFrames(), BasicUDPSource::doStopGettingFrames(), MPEG4VideoFileServerMediaSubsession::getAuxSDPLine(), H264VideoFileServerMediaSubsession::getAuxSDPLine(), getMPEG1or2TimeCode(), DVVideoStreamFramer::getProfile(), RTSPServer::RTSPClientConnection::handleAlternativeRequestByte1(), RTSPClient::handleAlternativeRequestByte1(), SIPClient::invite1(), main(), RTSPServer::RTSPClientSession::noteLiveness(), T140IdleFilter::onSourceClosure(), RTSPClient::openConnection(), TCPStreamSink::processBuffer(), AC3AudioStreamParser::readAndSaveAFrame(), SocketDescriptor::registerRTPInterface(), RTCPInstance::reschedule(), ProxyRTSPClient::reset(), RTSPClient::resetTCPSockets(), RTSPServer::RTSPClientConnection::RTSPClientConnection(), RTSPServer::RTSPServer(), RTCPInstance::schedule(), ProxyRTSPClient::scheduleDESCRIBECommand(), ProxyRTSPClient::scheduleLivenessCommand(), scheduleNextQOSMeasurement(), MultiFramedRTPSink::sendPacketIfNecessary(), sessionAfterPlaying(), DarwinInjector::setDestination(), RTSPServer::setUpTunnelingOverHTTP(), shutdown(), TCPStreamSink::socketWritableHandler1(), RTPInterface::startNetworkReading(), RTPInterface::stopNetworkReading(), MediaSink::stopPlaying(), waitUntilSocketIsReadable(), BasicUDPSource::~BasicUDPSource(), ByteStreamFileSource::~ByteStreamFileSource(), DeviceSource::~DeviceSource(), Medium::~Medium(), RTSPServer::RTSPClientSession::~RTSPClientSession(), RTSPServer::~RTSPServer(), SocketDescriptor::~SocketDescriptor(), StreamClientState::~StreamClientState(), T140IdleFilter::~T140IdleFilter(), and WAVAudioFileSource::~WAVAudioFileSource().

{return fScheduler;}

virtual MsgString UsageEnvironment::getResultMsg

(

)

const [pure virtual]

Implemented in BasicUsageEnvironment0.

Referenced by RTSPClient::connectionHandler1(), RTSPClient::connectToServer(), continueAfterDESCRIBE(), getOptions(), Groupsock::Groupsock(), main(), openURL(), Groupsock::output(), Groupsock::outputToAllMembersExcept(), play(), setupNextSubsession(), setupStreams(), SIPClient::SIPClient(), startPlayingSession(), tearDownSession(), and OutputSocket::write().

virtual void UsageEnvironment::setResultMsg

(

MsgString

msg

)

[pure virtual]

Referenced by QuickTimeFileSink::continuePlaying(), AVIFileSink::continuePlaying(), uLawFromPCMAudioSource::createNew(), MP3ADUTranscoder::createNew(), MP3FromADUSource::createNew(), ADUFromMP3Source::createNew(), AMRAudioFileSource::createNew(), ADTSAudioFileSource::createNew(), MediaSubsession::createSourceObjects(), MP3FileSource::doGetNextFrame1(), SIPClient::doInviteStateMachine(), RTPSource::getAttributes(), MP3FileSource::getAttributes(), MediaSource::getAttributes(), getOptions(), SIPClient::getResponse(), SIPClient::getResponseCode(), RTSPClient::handleGET_PARAMETERResponse(), RTSPClient::handlePLAYResponse(), Groupsock::handleRead(), RTSPClient::handleResponseBytes(), RTSPClient::handleSETUPResponse(), MP3FileSource::initializeStream(), MediaSession::initializeWithSDP(), MediaSubsession::initiate(), MediaSession::initiateByMediaType(), Medium::lookupByName(), Medium::Medium(), OpenInputFile(), OpenOutputFile(), ourIPAddress(), Groupsock::output(), SIPClient::parseResponseCode(), RTSPClient::parseRTSPURL(), SIPClient::parseSIPURL(), RTSPClient::sendRequest(), MediaSubsession::setClientPortNum(), setGroupsockBySocket(), QuickTimeFileSink::startPlaying(), MediaSink::startPlaying(), AVIFileSink::startPlaying(), 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,
		int	err = 0
	)			[pure virtual]

Referenced by RTSPClient::connectionHandler1(), RTSPClient::connectToServer(), RTSPServer::incomingConnectionHandler(), ourIPAddress(), SIPClient::sendACK(), SIPClient::sendBYE(), SIPClient::sendINVITE(), RTSPClient::sendRequest(), RTSPServer::setUpOurSocket(), and socketErr().

virtual void UsageEnvironment::appendToResultMsg

(

MsgString

msg

)

[pure virtual]

Referenced by MP3ADUTranscoder::getAttributes().

virtual void UsageEnvironment::reportBackgroundError

(

)

[pure virtual]

Implemented in BasicUsageEnvironment0.

Referenced by socketReadHandler().

void UsageEnvironment::internalError

(

)

[virtual]

Definition at line 36 of file UsageEnvironment.cpp.

Referenced by BasicUsageEnvironment::BasicUsageEnvironment(), AMRDeinterleavingBuffer::deliverIncomingFrame(), StreamParser::ensureValidBytes1(), FramedSource::getNextFrame(), and MPEG1or2Demux::registerReadInterest().

                                     {
  abort();
}

virtual int UsageEnvironment::getErrno

(

)

const [pure virtual]

Implemented in BasicUsageEnvironment.

Referenced by RTSPClient::connectToServer(), RTSPClient::handleRequestError(), RTSPServer::incomingConnectionHandler(), readSocket(), BasicUsageEnvironment0::setResultErrMsg(), QuickTimeFileSink::setWord(), AVIFileSink::setWord(), QuickTimeFileSink::setWord64(), 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 89 of file UsageEnvironment.hh.

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

void* UsageEnvironment::groupsockPriv

Definition at line 90 of file UsageEnvironment.hh.

Referenced by groupsockPriv(), reclaim(), and reclaimGroupsockPriv().

TaskScheduler& UsageEnvironment::fScheduler [private]

Definition at line 97 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

---