OpenCPN Partial API docs
Loading...
Searching...
No Matches
AndroidSerialIo Class Reference

Android SerialIo synchronous implementation based on the native Android serial interface as exposed in androidUTIL.h. More...

Inheritance diagram for AndroidSerialIo:
SerialIo ThreadCtrl

Public Member Functions

 AndroidSerialIo (SendMsgFunc send_func, const std::string &port, unsigned baud)
 
DriverStats GetStats () const
 Retrieve updated driver statistics.
 
bool SetOutMsg (const wxString &msg) override
 Send a message to remote peer.
 
void Start () override
 Start IO operations including input, possibly in separate thread.
 
void RequestStop () override
 Request that thread stops operation.
 
- Public Member Functions inherited from ThreadCtrl
bool IsRunning () const
 Return true if thread is running.
 
void WaitUntilStopped ()
 Block until thread invokes SignalExit().
 
bool WaitUntilStopped (std::chrono::duration< int > timeout)
 Block until thread invokes SignalExit() or timeout.
 
bool WaitUntilStopped (std::chrono::duration< int > timeout, std::chrono::milliseconds &elapsed)
 Block until thread invokes SignalExit() or timeout.
 

Additional Inherited Members

- Static Public Member Functions inherited from SerialIo
static std::unique_ptr< SerialIoCreate (SendMsgFunc send_msg_func, const std::string &port, unsigned baud)
 Factory.
 
- Protected Member Functions inherited from SerialIo
 SerialIo (SendMsgFunc send_msg_func, const std::string &port, unsigned baud)
 
- Protected Member Functions inherited from ThreadCtrl
bool KeepGoing () const
 If true continue thread operation, else exit and invoke SignalExit()
 
void SignalExit ()
 Signal that thread has exited.
 
- Protected Attributes inherited from SerialIo
const wxString m_portname
 
const unsigned m_baud
 
const SendMsgFunc m_send_msg_func
 
DriverStats m_stats
 
std::mutex m_stats_mutex
 
TimedLogFilter m_open_log_filter
 

Detailed Description

Android SerialIo synchronous implementation based on the native Android serial interface as exposed in androidUTIL.h.

Definition at line 45 of file android_serial_io.cpp.

Constructor & Destructor Documentation

◆ AndroidSerialIo()

AndroidSerialIo::AndroidSerialIo ( SendMsgFunc  send_func,
const std::string &  port,
unsigned  baud 
)
inline

Definition at line 47 of file android_serial_io.cpp.

Member Function Documentation

◆ GetStats()

DriverStats AndroidSerialIo::GetStats ( ) const
inlinevirtual

Retrieve updated driver statistics.

Implements SerialIo.

Definition at line 53 of file android_serial_io.cpp.

◆ RequestStop()

void AndroidSerialIo::RequestStop ( )
inlineoverridevirtual

Request that thread stops operation.

Implements SerialIo.

Definition at line 73 of file android_serial_io.cpp.

◆ SetOutMsg()

bool AndroidSerialIo::SetOutMsg ( const wxString &  msg)
inlineoverridevirtual

Send a message to remote peer.

Implements SerialIo.

Definition at line 56 of file android_serial_io.cpp.

◆ Start()

void AndroidSerialIo::Start ( )
inlineoverridevirtual

Start IO operations including input, possibly in separate thread.

Implements SerialIo.

Definition at line 66 of file android_serial_io.cpp.


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