BasicUsageEnvironment Class Reference

#include <BasicUsageEnvironment.hh>

Inheritance diagram for BasicUsageEnvironment:

Collaboration diagram for BasicUsageEnvironment:

Public Types
typedef char const *	MsgString

Public Member Functions
virtual int	getErrno () const
virtual UsageEnvironment &	operator<< (char const *str)
virtual UsageEnvironment &	operator<< (int i)
virtual UsageEnvironment &	operator<< (unsigned u)
virtual UsageEnvironment &	operator<< (double d)
virtual UsageEnvironment &	operator<< (void *p)
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, int err=0)
virtual void	appendToResultMsg (MsgString msg)
virtual void	reportBackgroundError ()
Boolean	reclaim ()
TaskScheduler &	taskScheduler () const
virtual void	internalError ()

Static Public Member Functions
static BasicUsageEnvironment *	createNew (TaskScheduler &taskScheduler)

Data Fields
void *	liveMediaPriv
void *	groupsockPriv

Protected Member Functions
	BasicUsageEnvironment (TaskScheduler &taskScheduler)
virtual	~BasicUsageEnvironment ()

Private Member Functions
void	reset ()

Private Attributes
char	fResultMsgBuffer [RESULT_MSG_BUFFER_MAX]
unsigned	fCurBufferSize
unsigned	fBufferMaxSize
TaskScheduler &	fScheduler

Detailed Description

Definition at line 27 of file BasicUsageEnvironment.hh.

Member Typedef Documentation

MsgString

typedef char const* UsageEnvironment::MsgString

inherited

Definition at line 68 of file UsageEnvironment.hh.

Constructor & Destructor Documentation

BasicUsageEnvironment()

BasicUsageEnvironment::BasicUsageEnvironment ( TaskScheduler & taskScheduler )

protected

References UsageEnvironment::taskScheduler().

Referenced by createNew().

~BasicUsageEnvironment()

virtual BasicUsageEnvironment::~BasicUsageEnvironment ( )

protectedvirtual

Member Function Documentation

appendToResultMsg()

virtual void BasicUsageEnvironment0::appendToResultMsg ( MsgString msg )

virtualinherited

Implements UsageEnvironment.

createNew()

BasicUsageEnvironment * BasicUsageEnvironment::createNew ( TaskScheduler & taskScheduler )

static

References BasicUsageEnvironment(), and UsageEnvironment::taskScheduler().

getErrno()

virtual int BasicUsageEnvironment::getErrno ( ) const

virtual

Implements UsageEnvironment.

getResultMsg()

virtual MsgString BasicUsageEnvironment0::getResultMsg ( ) const

virtualinherited

Implements UsageEnvironment.

internalError()

virtual void UsageEnvironment::internalError ( )

virtualinherited

operator<<() [1/5]

virtual UsageEnvironment & BasicUsageEnvironment::operator<< ( char const * str )

virtual

Implements UsageEnvironment.

References UsageEnvironment::UsageEnvironment().

operator<<() [2/5]

virtual UsageEnvironment & BasicUsageEnvironment::operator<< ( double d )

virtual

Implements UsageEnvironment.

References UsageEnvironment::UsageEnvironment().

operator<<() [3/5]

virtual UsageEnvironment & BasicUsageEnvironment::operator<< ( int i )

virtual

Implements UsageEnvironment.

References UsageEnvironment::UsageEnvironment().

operator<<() [4/5]

virtual UsageEnvironment & BasicUsageEnvironment::operator<< ( unsigned u )

virtual

Implements UsageEnvironment.

References UsageEnvironment::UsageEnvironment().

operator<<() [5/5]

virtual UsageEnvironment & BasicUsageEnvironment::operator<< ( void * p )

virtual

Implements UsageEnvironment.

References UsageEnvironment::UsageEnvironment().

reclaim()

Boolean UsageEnvironment::reclaim ( )

inherited

reportBackgroundError()

virtual void BasicUsageEnvironment0::reportBackgroundError ( )

virtualinherited

Implements UsageEnvironment.

reset()

void BasicUsageEnvironment0::reset ( )

privateinherited

setResultErrMsg()

virtual void BasicUsageEnvironment0::setResultErrMsg ( MsgString msg, int err = 0 )

virtualinherited

Implements UsageEnvironment.

setResultMsg() [1/3]

virtual void BasicUsageEnvironment0::setResultMsg ( MsgString msg )

virtualinherited

Implements UsageEnvironment.

setResultMsg() [2/3]

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

virtualinherited

Implements UsageEnvironment.

setResultMsg() [3/3]

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

virtualinherited

Implements UsageEnvironment.

taskScheduler()

TaskScheduler & UsageEnvironment::taskScheduler ( ) const

inlineinherited

Definition at line 65 of file UsageEnvironment.hh.

{return fScheduler;}

References fScheduler.

Referenced by BasicUsageEnvironment::BasicUsageEnvironment(), BasicUsageEnvironment0::BasicUsageEnvironment0(), and BasicUsageEnvironment::createNew().

Field Documentation

fBufferMaxSize

unsigned BasicUsageEnvironment0::fBufferMaxSize

privateinherited

Definition at line 65 of file BasicUsageEnvironment0.hh.

fCurBufferSize

unsigned BasicUsageEnvironment0::fCurBufferSize

privateinherited

Definition at line 64 of file BasicUsageEnvironment0.hh.

fResultMsgBuffer

char BasicUsageEnvironment0::fResultMsgBuffer[RESULT_MSG_BUFFER_MAX]

privateinherited

Definition at line 63 of file BasicUsageEnvironment0.hh.

fScheduler

TaskScheduler& UsageEnvironment::fScheduler

privateinherited

Definition at line 104 of file UsageEnvironment.hh.

Referenced by taskScheduler().

groupsockPriv

void* UsageEnvironment::groupsockPriv

inherited

Definition at line 97 of file UsageEnvironment.hh.

liveMediaPriv

void* UsageEnvironment::liveMediaPriv

inherited

Definition at line 96 of file UsageEnvironment.hh.

---

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

• BasicUsageEnvironment/include/BasicUsageEnvironment.hh