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

Additional Inherited Members

- Static Public Member Functions inherited from LocalServerApi
static LocalServerApiGetInstance ()
 
static void ReleaseInstance ()
 Release Instance.
 

Detailed Description

Implement LocalServerApi using a filesystem fifo/socket.

Definition at line 108 of file ipc_api.h.


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