OPAL  Version 3.18.8
OpalConsoleEndPoint Class Referenceabstract

#include <console_mgr.h>

Inheritance diagram for OpalConsoleEndPoint:
Collaboration diagram for OpalConsoleEndPoint:

Public Types

enum  InitResult { InitFailed, InitDisabled, InitSuccess }
 

Public Member Functions

virtual ~OpalConsoleEndPoint ()
 
virtual void GetArgumentSpec (ostream &strm) const =0
 
virtual bool Initialise (PArgList &args, bool verbose, const PString &defaultRoute)=0
 
void SetEndpointDisabled (bool disabled)
 

Protected Member Functions

 OpalConsoleEndPoint (OpalManagerConsole &console)
 
void AddRoutesFor (const OpalEndPoint *endpoint, const PString &defaultRoute)
 

Protected Attributes

OpalManagerConsolem_console
 
bool m_endpointDisabled
 

Detailed Description

This class allows for each end point class, e.g. SIPEndPoint, to add it's set of parameters/commands to to the console application.

Member Enumeration Documentation

Enumerator
InitFailed 
InitDisabled 
InitSuccess 

Constructor & Destructor Documentation

OpalConsoleEndPoint::OpalConsoleEndPoint ( OpalManagerConsole console)
inlineprotected
virtual OpalConsoleEndPoint::~OpalConsoleEndPoint ( )
inlinevirtual

Member Function Documentation

void OpalConsoleEndPoint::AddRoutesFor ( const OpalEndPoint endpoint,
const PString &  defaultRoute 
)
protected
virtual void OpalConsoleEndPoint::GetArgumentSpec ( ostream &  strm) const
pure virtual
virtual bool OpalConsoleEndPoint::Initialise ( PArgList &  args,
bool  verbose,
const PString &  defaultRoute 
)
pure virtual
void OpalConsoleEndPoint::SetEndpointDisabled ( bool  disabled)
inline

References m_endpointDisabled.

Field Documentation

OpalManagerConsole& OpalConsoleEndPoint::m_console
protected
bool OpalConsoleEndPoint::m_endpointDisabled
protected

Referenced by SetEndpointDisabled().


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