PTLib  Version 2.14.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PSecureHTTPServiceProcess Class Reference

#include <shttpsvc.h>

Inheritance diagram for PSecureHTTPServiceProcess:
Collaboration diagram for PSecureHTTPServiceProcess:

Public Member Functions

 PSecureHTTPServiceProcess (const Info &inf)
 
 ~PSecureHTTPServiceProcess ()
 
virtual PHTTPServerCreateHTTPServer (PTCPSocket &socket)
 
bool SetServerCertificate (const PFilePath &certFile, bool create=false, const char *dn=NULL)
 
virtual PBoolean OnDetectedNonSSLConnection (PChannel *chan, const PString &line)
 
virtual PString CreateNonSSLMessage (const PString &url)
 
virtual PString CreateRedirectMessage (const PString &url)
 
void DisableSSL ()
 
- Public Member Functions inherited from PHTTPServiceProcess
 PHTTPServiceProcess (const Info &inf)
 
 ~PHTTPServiceProcess ()
 
PBoolean OnStart ()
 Called when the service is started. More...
 
void OnStop ()
 Called by the system when the service is stopped. More...
 
PBoolean OnPause ()
 Called by the system when the service is to be paused. More...
 
void OnContinue ()
 Resume after the service was paused. More...
 
const char * GetServiceDependencies () const
 
virtual void OnConfigChanged ()=0
 
virtual PBoolean Initialise (const char *initMsg)=0
 
bool ListenForHTTP (WORD port, PSocket::Reusability reuse=PSocket::CanReuseAddress, PINDEX stackSize=0x4000)
 
bool ListenForHTTP (const PString &interfaces, WORD port, PSocket::Reusability reuse=PSocket::CanReuseAddress, PINDEX stackSize=0x4000)
 
bool ListenForHTTP (PSocket *listener, PSocket::Reusability reuse=PSocket::CanReuseAddress, PINDEX stackSize=0x4000)
 
virtual PString GetPageGraphic ()
 
void GetPageHeader (PHTML &)
 
void GetPageHeader (PHTML &, const PString &title)
 
virtual PString GetCopyrightText ()
 
const PStringGetMacroKeyword () const
 
const PTimeGetCompilationDate () const
 
const PStringGetHomePage () const
 
const PStringGetEMailAddress () const
 
const PStringGetProductName () const
 
const PTEACypher::KeyGetProductKey () const
 
const PStringArrayGetSecuredKeys () const
 
const PTEACypher::KeyGetSignatureKey () const
 
bool ShouldIgnoreSignatures () const
 
void SetIgnoreSignatures (bool ig)
 
virtual void AddRegisteredText (PHTML &html)
 
virtual void AddUnregisteredText (PHTML &html)
 
virtual PBoolean SubstituteEquivalSequence (PHTTPRequest &request, const PString &, PString &)
 
virtual PHTTPServerOnCreateHTTPServer (const PHTTPSpace &urlSpace)
 
PTCPSocketAcceptHTTP ()
 
PBoolean ProcessHTTP (PTCPSocket &socket)
 
- Public Member Functions inherited from PServiceProcess
virtual void Main ()
 User override function for the main execution routine of the thread. More...
 
virtual int InternalMain (void *arg=NULL)
 Main function for process, called from real main after initialisation. More...
 
 ~PServiceProcess ()
 
virtual void Terminate ()
 Terminate the process. More...
 
 PServiceProcess (const char *manuf, const char *name, unsigned majorVersion, unsigned minorVersion, CodeStatus status, unsigned buildNumber)
 Create a new service process. More...
 
virtual void OnControl ()=0
 The Control menu option was used in the SysTray menu. More...
 
void SetLogLevel (PSystemLog::Level level)
 Set the level at which errors are logged. More...
 
PSystemLog::Level GetLogLevel () const
 Get the current level for logging. More...
 
- Public Member Functions inherited from PProcess
void PreInitialise (int argc, char **argv)
 Internal initialisation function called directly from InternalMain(). More...
 
void PreShutdown ()
 Internal shutdown function called directly from the ~PProcess InternalMain(). More...
 
PThreadGetThread (PThreadIdentifier threadId) const
 
bool SignalTimerChange ()
 
 ~PProcess ()
 
void PXCheckSignals ()
 
Comparison Compare (const PObject &obj) const
 Compare two process instances. More...
 
 PProcess (const char *manuf="", const char *name="", unsigned majorVersion=1, unsigned minorVersion=0, CodeStatus status=ReleaseCode, unsigned buildNumber=1, bool library=false, bool suppressStartup=false)
 Create a new process instance. More...
 
void Startup ()
 Start up all items registered with PProcessStartupFactory. More...
 
virtual void OnThreadStart (PThread &thread)
 Callback for when a thread is started by the PTLib system. More...
 
virtual void OnThreadEnded (PThread &thread)
 Callback for when a thread is ended if wqas started in the PTLib system. More...
 
virtual bool OnInterrupt (bool terminating)
 Callback for when a ^C (SIGINT), hangup (SIGHUP) or termination request (SIGTERM) is received by process. More...
 
void SetTerminationValue (int value)
 Set the termination value for the process. More...
 
int GetTerminationValue () const
 Get the termination value for the process. More...
 
PArgListGetArguments ()
 Get the programme arguments. More...
 
virtual const PStringGetManufacturer () const
 Get the name of the manufacturer of the software. More...
 
virtual const PStringGetName () const
 Get the name of the process. More...
 
virtual PString GetVersion (PBoolean full=true) const
 Get the version of the software. More...
 
const PFilePathGetFile () const
 Get the processes executable image file path. More...
 
PProcessIdentifier GetProcessID () const
 Get the platform dependent process identifier for the process. More...
 
PTime GetStartTime () const
 Return the time at which the program was started. More...
 
PString GetUserName () const
 Get the effective user name of the owner of the process, eg "root" etc. More...
 
PBoolean SetUserName (const PString &username, PBoolean permanent=false)
 Set the effective owner of the process. More...
 
PDirectory GetHomeDirectory () const
 Get the "home" directory for the logged in user. More...
 
PString GetGroupName () const
 Get the effective group name of the owner of the process, eg "root" etc. More...
 
PBoolean SetGroupName (const PString &groupname, PBoolean permanent=false)
 Set the effective group of the process. More...
 
int GetMaxHandles () const
 Get the maximum file handle value for the process. More...
 
PBoolean SetMaxHandles (int newLimit)
 Set the maximum number of file handles for the process. More...
 
virtual PString GetConfigurationFile ()
 Get the default file to use in PConfig instances. More...
 
void SetConfigurationPath (const PString &path)
 Set the default file or set of directories to search for use in PConfig. More...
 
- Public Member Functions inherited from PThread
bool IsAutoDelete () const
 
int PXBlockOnChildTerminate (int pid, const PTimeInterval &timeout)
 
int PXBlockOnIO (int handle, int type, const PTimeInterval &timeout)
 
void PXAbortBlock () const
 
void PrintOn (ostream &strm) const
 Standard stream print function. More...
 
 PThread (PINDEX stack, AutoDeleteFlag deletion=AutoDeleteThread, Priority priorityLevel=NormalPriority, const PString &threadName=PString::Empty())
 Create a new thread instance. More...
 
 ~PThread ()
 Destroy the thread, this simply calls the Terminate() function with all its restrictions and penalties. More...
 
virtual void Restart ()
 Restart a terminated thread using the same stack priority etc that was current when the thread terminated. More...
 
virtual PBoolean IsTerminated () const
 Determine if the thread has been terminated or ran to completion. More...
 
void WaitForTermination () const
 Block and wait for the thread to terminate. More...
 
PBoolean WaitForTermination (const PTimeInterval &maxWait) const
 Block and wait for the thread to terminate. More...
 
virtual void Suspend (PBoolean susp=true)
 Suspend or resume the thread. More...
 
virtual void Resume ()
 Resume thread execution, this is identical to Suspend(false). More...
 
virtual PBoolean IsSuspended () const
 Determine if the thread is currently suspended. More...
 
virtual void SetPriority (Priority priorityLevel)
 Set the priority of the thread relative to other threads in the current process. More...
 
virtual Priority GetPriority () const
 Get the current priority of the thread in the current process. More...
 
virtual void SetAutoDelete (AutoDeleteFlag deletion=AutoDeleteThread)
 Set the flag indicating thread object is to be automatically deleted when the thread ends. More...
 
void SetNoAutoDelete ()
 Reet the flag indicating thread object is to be automatically deleted when the thread ends. More...
 
virtual PString GetThreadName () const
 Get the name of the thread. More...
 
virtual void SetThreadName (const PString &name)
 Change the name of the thread. More...
 
virtual PThreadIdentifier GetThreadId () const
 Get operating system specific thread identifier for this thread. More...
 
bool GetTimes (Times &times)
 Get the thread execution times. More...
 
- Public Member Functions inherited from PObject
unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
void SetTraceContextIdentifier (unsigned id)
 
void GetTraceContextIdentifier (PObject &obj)
 
void GetTraceContextIdentifier (PObject *obj)
 
void SetTraceContextIdentifier (const PObject &obj)
 
void SetTraceContextIdentifier (const PObject *obj)
 
virtual ~PObject ()
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
template<class CLS >
CLS * CloneAs () const
 As for Clone() but converts to specified type. More...
 
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class. More...
 
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
PBoolean IsClass (const char *cls) const
 
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class. More...
 
__inline const PObjectPTraceObjectInstance () const
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Protected Attributes

PSSLContextm_sslContext
 
- Protected Attributes inherited from PHTTPServiceProcess
PSocketList m_httpListeningSockets
 
PHTTPSpace httpNameSpace
 
PString macroKeyword
 
PTEACypher::Key productKey
 
PStringArray securedKeys
 
PTEACypher::Key signatureKey
 
bool ignoreSignatures
 
PTime compilationDate
 
PString manufacturersHomePage
 
PString manufacturersEmail
 
PString productNameHTML
 
PString gifHTML
 
PString copyrightHolder
 
PString copyrightHomePage
 
PString copyrightEmail
 
PThreadrestartThread
 
ThreadList httpThreads
 
PMutex httpThreadsMutex
 
- Protected Attributes inherited from PServiceProcess
PSyncPoint m_exitMain
 
bool m_debugMode
 Flag to indicate service is run in simulation mode. More...
 
PString pidFileToRemove
 
PBoolean isTerminating
 
- Protected Attributes inherited from PProcess
bool m_library
 
int terminationValue
 
PString manufacturer
 
PString productName
 
unsigned majorVersion
 
unsigned minorVersion
 
CodeStatus status
 
unsigned buildNumber
 
PFilePath executableFile
 
PStringArray configurationPaths
 
PArgList arguments
 
int maxHandles
 
PTime programStartTime
 
bool m_shuttingDown
 
PMutex m_threadMutex
 
ThreadMap m_activeThreads
 
ThreadList m_autoDeleteThreads
 
PAtomicBoolean m_keepingHouse
 
PThreadm_houseKeeper
 
PSyncPoint m_signalHouseKeeper
 
PTimer::Listm_timerList
 
PProcessIdentifier m_processID
 
uint32_t m_pxSignals
 
- Protected Attributes inherited from PThread
enum PThread::Type m_type
 
PINDEX m_originalStackSize
 
PString m_threadName
 
PMutex m_threadNameMutex
 
PThreadIdentifier m_threadId
 
LocalStorageList m_localStorage
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Additional Inherited Members

- Public Types inherited from PHTTPServiceProcess
enum  { MaxSecuredKeys = 10 }
 
- Static Public Member Functions inherited from PHTTPServiceProcess
static PHTTPServiceProcessCurrent ()
 
- Protected Types inherited from PProcess
typedef std::map
< PThreadIdentifier, PThread * > 
ThreadMap
 
typedef PList< PThreadThreadList
 
- Protected Member Functions inherited from PHTTPServiceProcess
void ShutdownListener ()
 
void BeginRestartSystem ()
 
void CompleteRestartSystem ()
 
 PLIST (ThreadList, PHTTPServiceThread)
 
- Friends inherited from PObject

Constructor & Destructor Documentation

PSecureHTTPServiceProcess::PSecureHTTPServiceProcess ( const Info inf)
PSecureHTTPServiceProcess::~PSecureHTTPServiceProcess ( )

Member Function Documentation

virtual PHTTPServer* PSecureHTTPServiceProcess::CreateHTTPServer ( PTCPSocket socket)
virtual

Reimplemented from PHTTPServiceProcess.

virtual PString PSecureHTTPServiceProcess::CreateNonSSLMessage ( const PString url)
virtual
virtual PString PSecureHTTPServiceProcess::CreateRedirectMessage ( const PString url)
virtual
void PSecureHTTPServiceProcess::DisableSSL ( )
virtual PBoolean PSecureHTTPServiceProcess::OnDetectedNonSSLConnection ( PChannel chan,
const PString line 
)
virtual
bool PSecureHTTPServiceProcess::SetServerCertificate ( const PFilePath certFile,
bool  create = false,
const char *  dn = NULL 
)

Member Data Documentation

PSSLContext* PSecureHTTPServiceProcess::m_sslContext
protected

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