OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
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.
 

Static Public Member Functions

static LocalServerApi & GetInstance ()
 
static void ReleaseInstance ()
 

Public Attributes

IpcServer & server
 

Protected Member Functions

 IpcConnection (IpcServer &s)
 

Friends

class IpcServer
 

Detailed Description

Started by IpcServer on filesystem fifo/socket connects.

Definition at line 68 of file ipc_api.h.

Constructor & Destructor Documentation

◆ IpcConnection()

IpcConnection::IpcConnection ( IpcServer & s)
inlineprotected

Definition at line 92 of file ipc_api.h.

Member Function Documentation

◆ GetInstance()

LocalServerApi & IpcConnection::GetInstance ( )
static

Definition at line 75 of file ipc_api.cpp.

◆ OnExec()

bool IpcConnection::OnExec ( const wxString & ,
const wxString & data )

Handle commands without reply: quit and raise.

Definition at line 87 of file ipc_api.cpp.

◆ 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 99 of file ipc_api.cpp.

◆ ReleaseInstance()

void IpcConnection::ReleaseInstance ( )
static

Definition at line 80 of file ipc_api.cpp.

Friends And Related Symbol Documentation

◆ IpcServer

friend class IpcServer
friend

Definition at line 69 of file ipc_api.h.

Member Data Documentation

◆ server

IpcServer& IpcConnection::server

Definition at line 78 of file ipc_api.h.

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