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

Implement LocalServerApi using a filesystem fifo/socket. More...

#include <ipc_api.h>

Inheritance diagram for IpcServer:
LocalServerApi

Public Member Functions

 IpcServer (const std::string &path)
wxConnectionBase * OnAcceptConnection (const wxString &topic)
void Serve ()
 void, we are serving as long as there is a ServerFactory.
Public Member Functions inherited from LocalServerApi
virtual void SetGetRestApiEndpointCb (std::function< std::string()> cb)
 Set callback returning the rest server root endpoint.

Public Attributes

const bool is_connected
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

Additional Inherited Members

Static Public Member Functions inherited from LocalServerApi
static LocalServerApi & GetInstance ()
static void ReleaseInstance ()
 Release Instance.
Protected Member Functions inherited from LocalServerApi
 ~LocalServerApi ()=default
 Destroy the Local Server Api object.

Detailed Description

Implement LocalServerApi using a filesystem fifo/socket.

Definition at line 101 of file ipc_api.h.

Constructor & Destructor Documentation

◆ IpcServer() [1/2]

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

Definition at line 105 of file ipc_api.h.

◆ IpcServer() [2/2]

IpcServer::IpcServer ( )
inline

Definition at line 107 of file ipc_api.h.

Member Function Documentation

◆ OnAcceptConnection()

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

Definition at line 109 of file ipc_api.h.

◆ Serve()

void IpcServer::Serve ( )
inline

void, we are serving as long as there is a ServerFactory.

Definition at line 114 of file ipc_api.h.

Member Data Documentation

◆ is_connected

const bool IpcServer::is_connected

Definition at line 103 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