OpenCPN Partial API docs
Loading...
Searching...
No Matches
DummyIpcServer Class Reference

Useless place holder for LocalServerApi. More...

#include <ipc_api.h>

Inheritance diagram for DummyIpcServer:
LocalServerApi

Public Member Functions

 DummyIpcServer (const std::string &path)
wxConnectionBase * OnAcceptConnection (const wxString &topic)
void Serve ()
Public Member Functions inherited from LocalServerApi
virtual void SetGetRestApiEndpointCb (std::function< std::string()> cb)
 Set callback returning the rest server root endpoint.

Static Public Member Functions

static DummyIpcServer & GetInstance ()
Static Public Member Functions inherited from LocalServerApi
static LocalServerApi & GetInstance ()
static void ReleaseInstance ()
 Release Instance.

Protected Member Functions

 ~DummyIpcServer ()=default
 Destroy the Dummy Ipc Server object.
Protected Member Functions inherited from LocalServerApi
 ~LocalServerApi ()=default
 Destroy the Local Server Api object.

Additional Inherited Members

Public Attributes inherited from LocalServerApi
obs::EventVar on_raise
 Notified on the Raise command.
obs::EventVar on_quit
 Notified on the Quit command.
std::function< bool(const std::string &)> open_file_cb
 Callback invoked on open command with a file path argument.
std::function< std::string()> get_rest_api_endpoint_cb

Detailed Description

Useless place holder for LocalServerApi.

Definition at line 120 of file ipc_api.h.

Constructor & Destructor Documentation

◆ DummyIpcServer() [1/2]

DummyIpcServer::DummyIpcServer ( )
inline

Definition at line 127 of file ipc_api.h.

◆ DummyIpcServer() [2/2]

DummyIpcServer::DummyIpcServer ( const std::string & path)
inline

Definition at line 128 of file ipc_api.h.

Member Function Documentation

◆ GetInstance()

DummyIpcServer & DummyIpcServer::GetInstance ( )
inlinestatic

Definition at line 122 of file ipc_api.h.

◆ OnAcceptConnection()

wxConnectionBase * DummyIpcServer::OnAcceptConnection ( const wxString & topic)
inline

Definition at line 130 of file ipc_api.h.

◆ Serve()

void DummyIpcServer::Serve ( )
inline

Definition at line 135 of file ipc_api.h.


The documentation for this class was generated from the following file:
  • /home/runner/work/main/main/opencpn/model/include/model/ipc_api.h