OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
LocalClientApi Class Referenceabstract

Base interface for local clients. More...

#include <local_api.h>

Inheritance diagram for LocalClientApi:
DbusLocalClient DummyIpcClient IpcClient

Public Member Functions

virtual LocalApiResult HandleCmdline (const wxCmdLineParser &parser)
 
virtual LocalApiResult HandleCmdline (CmdlineAction action, const std::string &arg)
 
virtual LocalApiResult SendRaise ()=0
 
virtual LocalApiResult SendOpen (const char *path)=0
 
virtual LocalApiResult SendQuit ()=0
 
virtual LocalApiResult GetRestEndpoint ()=0
 

Static Public Member Functions

static std::unique_ptr< LocalClientApi > GetClient ()
 

Protected Member Functions

CmdlineAction ParseArgs (const wxCmdLineParser &parser, std::string &arg)
 

Detailed Description

Base interface for local clients.

Definition at line 91 of file local_api.h.

Member Function Documentation

◆ GetClient()

std::unique_ptr< LocalClientApi > LocalClientApi::GetClient ( )
static

Definition at line 86 of file ipc_factories.cpp.

◆ HandleCmdline() [1/2]

LocalApiResult LocalClientApi::HandleCmdline ( CmdlineAction  action,
const std::string &  arg 
)
virtual

Definition at line 67 of file local_api.cpp.

◆ HandleCmdline() [2/2]

LocalApiResult LocalClientApi::HandleCmdline ( const wxCmdLineParser &  parser)
virtual

Definition at line 61 of file local_api.cpp.

◆ ParseArgs()

CmdlineAction LocalClientApi::ParseArgs ( const wxCmdLineParser &  parser,
std::string &  arg 
)
protected

Definition at line 34 of file local_api.cpp.

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