BasicUsageEnvironment0 Class Reference

#include <BasicUsageEnvironment0.hh>

Inheritance diagram for BasicUsageEnvironment0:

Inheritance graph
[legend]
Collaboration diagram for BasicUsageEnvironment0:

Collaboration graph
[legend]

Public Types

typedef char const * MsgString

Public Member Functions

virtual MsgString getResultMsg () const
virtual void setResultMsg (MsgString msg)
virtual void setResultMsg (MsgString msg1, MsgString msg2)
virtual void setResultMsg (MsgString msg1, MsgString msg2, MsgString msg3)
virtual void setResultErrMsg (MsgString msg)
virtual void appendToResultMsg (MsgString msg)
virtual void reportBackgroundError ()
void reclaim ()
TaskScheduler & taskScheduler () const
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 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

 BasicUsageEnvironment0 (TaskScheduler &taskScheduler)
virtual ~BasicUsageEnvironment0 ()

Private Member Functions

void reset ()

Private Attributes

char fResultMsgBuffer [RESULT_MSG_BUFFER_MAX]
unsigned fCurBufferSize
unsigned fBufferMaxSize

Detailed Description

Definition at line 39 of file BasicUsageEnvironment0.hh.

Member Typedef Documentation

typedef char const* UsageEnvironment::MsgString [inherited]

Definition at line 57 of file UsageEnvironment.hh.

Constructor & Destructor Documentation

BasicUsageEnvironment0::BasicUsageEnvironment0 ( TaskScheduler &  taskScheduler  )  [protected]

Definition at line 25 of file BasicUsageEnvironment0.cpp.

References reset().

00026   : UsageEnvironment(taskScheduler),
00027     fBufferMaxSize(RESULT_MSG_BUFFER_MAX) {
00028   reset();
00029 }

BasicUsageEnvironment0::~BasicUsageEnvironment0 (  )  [protected, virtual]

Definition at line 31 of file BasicUsageEnvironment0.cpp.

00031                                                 {
00032 }

Member Function Documentation

char const * BasicUsageEnvironment0::getResultMsg (  )  const [virtual]

Implements UsageEnvironment.

Definition at line 42 of file BasicUsageEnvironment0.cpp.

References fResultMsgBuffer.

00042                                                        {
00043   return fResultMsgBuffer;
00044 }

void BasicUsageEnvironment0::setResultMsg ( MsgString  msg  )  [virtual]

Definition at line 46 of file BasicUsageEnvironment0.cpp.

References appendToResultMsg(), and reset().

Referenced by setResultErrMsg(), and setResultMsg().

00046                                                        {
00047   reset();
00048   appendToResultMsg(msg);
00049 }

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

Definition at line 51 of file BasicUsageEnvironment0.cpp.

References appendToResultMsg(), and setResultMsg().

00051                                                                         {
00052   setResultMsg(msg1);
00053   appendToResultMsg(msg2);
00054 }

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

Definition at line 56 of file BasicUsageEnvironment0.cpp.

References appendToResultMsg(), and setResultMsg().

00057                                                        {
00058   setResultMsg(msg1, msg2);
00059   appendToResultMsg(msg3);
00060 }

void BasicUsageEnvironment0::setResultErrMsg ( MsgString  msg  )  [virtual]

Definition at line 62 of file BasicUsageEnvironment0.cpp.

References appendToResultMsg(), UsageEnvironment::getErrno(), and setResultMsg().

Referenced by BasicUsageEnvironment::BasicUsageEnvironment().

00062                                                           {
00063   setResultMsg(msg);
00064 
00065 #ifndef _WIN32_WCE
00066   appendToResultMsg(strerror(getErrno()));
00067 #endif
00068 }

void BasicUsageEnvironment0::appendToResultMsg ( MsgString  msg  )  [virtual]

Definition at line 70 of file BasicUsageEnvironment0.cpp.

References fBufferMaxSize, fCurBufferSize, and fResultMsgBuffer.

Referenced by setResultErrMsg(), and setResultMsg().

00070                                                             {
00071   char* curPtr = &fResultMsgBuffer[fCurBufferSize];
00072   unsigned spaceAvailable = fBufferMaxSize - fCurBufferSize;
00073   unsigned msgLength = strlen(msg);
00074 
00075   // Copy only enough of "msg" as will fit:
00076   if (msgLength > spaceAvailable-1) {
00077     msgLength = spaceAvailable-1;
00078   }
00079 
00080   memmove(curPtr, (char*)msg, msgLength);
00081   fCurBufferSize += msgLength;
00082   fResultMsgBuffer[fCurBufferSize] = '\0';
00083 }

void BasicUsageEnvironment0::reportBackgroundError (  )  [virtual]

Implements UsageEnvironment.

Definition at line 85 of file BasicUsageEnvironment0.cpp.

References fResultMsgBuffer.

Referenced by BasicUsageEnvironment::BasicUsageEnvironment().

00085                                                    {
00086   fputs(fResultMsgBuffer, stderr);
00087 }

void BasicUsageEnvironment0::reset (  )  [private]

Definition at line 34 of file BasicUsageEnvironment0.cpp.

References fCurBufferSize, and fResultMsgBuffer.

Referenced by BasicUsageEnvironment0(), and setResultMsg().

00034                                    {
00035   fCurBufferSize = 0;
00036   fResultMsgBuffer[fCurBufferSize] = '\0';
00037 }

void UsageEnvironment::reclaim (  )  [inherited]

Definition at line 22 of file UsageEnvironment.cpp.

References UsageEnvironment::groupsockPriv, UsageEnvironment::liveMediaPriv, and NULL.

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

TaskScheduler& UsageEnvironment::taskScheduler (  )  const [inline, inherited]

Definition at line 54 of file UsageEnvironment.hh.

References UsageEnvironment::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().

00054 {return fScheduler;}

virtual void UsageEnvironment::setResultMsg ( MsgString  msg  )  [pure virtual, inherited]

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, inherited]

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

virtual void UsageEnvironment::setResultErrMsg ( MsgString  msg  )  [pure virtual, inherited]

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, inherited]

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

virtual int UsageEnvironment::getErrno (  )  const [pure virtual, inherited]

Implemented in BasicUsageEnvironment.

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

virtual UsageEnvironment& UsageEnvironment::operator<< ( char const *  str  )  [pure virtual, inherited]

Implemented in BasicUsageEnvironment.

virtual UsageEnvironment& UsageEnvironment::operator<< ( int  i  )  [pure virtual, inherited]

Implemented in BasicUsageEnvironment.

virtual UsageEnvironment& UsageEnvironment::operator<< ( unsigned  u  )  [pure virtual, inherited]

Implemented in BasicUsageEnvironment.

virtual UsageEnvironment& UsageEnvironment::operator<< ( double  d  )  [pure virtual, inherited]

Implemented in BasicUsageEnvironment.

virtual UsageEnvironment& UsageEnvironment::operator<< ( void *  p  )  [pure virtual, inherited]

Implemented in BasicUsageEnvironment.

Field Documentation

char BasicUsageEnvironment0::fResultMsgBuffer[RESULT_MSG_BUFFER_MAX] [private]

Definition at line 63 of file BasicUsageEnvironment0.hh.

Referenced by appendToResultMsg(), getResultMsg(), reportBackgroundError(), and reset().

unsigned BasicUsageEnvironment0::fCurBufferSize [private]

Definition at line 64 of file BasicUsageEnvironment0.hh.

Referenced by appendToResultMsg(), and reset().

unsigned BasicUsageEnvironment0::fBufferMaxSize [private]

Definition at line 65 of file BasicUsageEnvironment0.hh.

Referenced by appendToResultMsg().

void* UsageEnvironment::liveMediaPriv [inherited]

Definition at line 83 of file UsageEnvironment.hh.

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

void* UsageEnvironment::groupsockPriv [inherited]

Definition at line 84 of file UsageEnvironment.hh.

Referenced by getSocketTable(), and UsageEnvironment::reclaim().

The documentation for this class was generated from the following files:
Generated on Tue Jul 22 06:40:32 2008 for live by  doxygen 1.5.2