OpenCPN Partial API docs
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
LocalServerApi Class Reference

Base interface for local server command handling. More...

#include <local_api.h>

Inheritance diagram for LocalServerApi:
DbusServer DummyIpcServer IpcServer

Public Member Functions

virtual void SetGetRestApiEndpointCb (std::function< std::string()> cb)
 Set callback returning the rest server root endpoint.
 

Static Public Member Functions

static LocalServerApi & GetInstance ()
 
static void ReleaseInstance ()
 Release Instance.
 

Public Attributes

EventVar on_raise
 Notified on the Raise command.
 
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

Base interface for local server command handling.

Definition at line 62 of file local_api.h.

Member Function Documentation

◆ GetInstance()

LocalServerApi & LocalServerApi::GetInstance ( )
static
Returns
Reference to a LocalServerApi implementation.

Definition at line 89 of file ipc_factories.cpp.

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