OpenCPN Partial API docs
IpcConnection Class Reference

Started by IpcServer on filesystem fifo/socket connects. More...

#include <ipc_api.h>

Inheritance diagram for IpcConnection:

Public Member Functions

 IpcConnection (IpcConnection &)=delete
 
void operator= (const IpcConnection &)=delete
 
bool OnExec (const wxString &, const wxString &data)
 Handle commands without reply: quit and raise.
 
const void * OnRequest (const wxString &topic, const wxString &item, size_t *size, wxIPCFormat format)
 Handle commands with a reply. More...
 

Static Public Member Functions

static LocalServerApiGetInstance ()
 
static void ReleaseInstance ()
 

Public Attributes

IpcServerserver
 

Protected Member Functions

 IpcConnection (IpcServer &s)
 

Friends

class IpcServer
 

Detailed Description

Started by IpcServer on filesystem fifo/socket connects.

Definition at line 73 of file ipc_api.h.

Member Function Documentation

◆ OnRequest()

const void * IpcConnection::OnRequest ( const wxString &  topic,
const wxString &  item,
size_t *  size,
wxIPCFormat  format 
)

Handle commands with a reply.

  • open <path>, returns "ok" or "fail"
  • get_api_endpoint, returns endpoint string.

Definition at line 103 of file ipc_api.cpp.


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