OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
InstanceCheck Class Referenceabstract

Common interface for all instance checkers. More...

#include <instance_check.h>

Inheritance diagram for InstanceCheck:
DbusInstanceCheck DbusServer DummyInstanceChk StdInstanceCheck WxInstanceCheck

Public Member Functions

virtual bool IsMainInstance ()=0
 Return true if this process is the primary opencpn instance.
 
virtual void WaitUntilValid ()
 Wait until this object can be used for example for Dbus connection.
 
virtual void CleanUp ()
 Remove all persistent instance state, including possible lock file and defunct opencpn processes.
 
virtual void OnExit ()
 Do whatever needed before wxWidget's checks triggers.
 

Static Public Member Functions

static InstanceCheck & GetInstance ()
 

Detailed Description

Common interface for all instance checkers.

Definition at line 26 of file instance_check.h.

Member Function Documentation

◆ CleanUp()

virtual void InstanceCheck::CleanUp ( )
inlinevirtual

Remove all persistent instance state, including possible lock file and defunct opencpn processes.

Reimplemented in StdInstanceCheck, and WxInstanceCheck.

Definition at line 43 of file instance_check.h.

◆ GetInstance()

InstanceCheck & InstanceCheck::GetInstance ( )
static
Returns
Reference to an InstanceCheck implementation.

Definition at line 96 of file ipc_factories.cpp.

◆ IsMainInstance()

virtual bool InstanceCheck::IsMainInstance ( )
pure virtual

Return true if this process is the primary opencpn instance.

Implemented in DbusServer, DummyInstanceChk, StdInstanceCheck, and WxInstanceCheck.

◆ OnExit()

virtual void InstanceCheck::OnExit ( )
inlinevirtual

Do whatever needed before wxWidget's checks triggers.

Reimplemented in WxInstanceCheck.

Definition at line 46 of file instance_check.h.

◆ WaitUntilValid()

virtual void InstanceCheck::WaitUntilValid ( )
inlinevirtual

Wait until this object can be used for example for Dbus connection.

Reimplemented in DbusServer.

Definition at line 37 of file instance_check.h.

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