OpenCPN Partial API docs
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 InstanceCheckGetInstance ()
 

Detailed Description

Common interface for all instance checkers.

Definition at line 26 of file instance_check.h.

Member Function Documentation

◆ GetInstance()

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

Definition at line 95 of file ipc_factories.cpp.


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