MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
MayaFlux::Core::NetworkSerialLink Class Reference

An ISerialLink over a SERIAL endpoint of the NetworkService. More...

#include <NetworkSerialLink.hpp>

Inheritance diagram for MayaFlux::Core::NetworkSerialLink:
Collaboration diagram for MayaFlux::Core::NetworkSerialLink:

Classes

struct  Shared

Public Member Functions

size_t backlog () const override
 Bytes accepted by write() and not yet sent.
void cancel_post (TimerToken token) override
 Cancel a timer.
void close () override
 Close the port.
 NetworkSerialLink (const NetworkSerialLink &)=delete
 NetworkSerialLink (NetworkSerialLink &&)=delete
 NetworkSerialLink (Registry::Service::NetworkService *service)
bool open (const std::string &path, const SerialLineSettings &line) override
 Open the port at path with line.
NetworkSerialLink & operator= (const NetworkSerialLink &)=delete
NetworkSerialLink & operator= (NetworkSerialLink &&)=delete
TimerToken post_after (std::chrono::milliseconds delay, std::function< void()> callback) override
 Run callback once after delay on the link's thread.
bool send_break () override
void set_chunk_callback (ChunkCallback callback) override
bool set_control_lines (std::optional< bool > dtr, std::optional< bool > rts) override
 Set DTR and RTS, each optional so one can change alone.
void set_state_callback (StateCallback callback) override
EndpointState state () const override
bool write (std::span< const uint8_t > bytes) override
 ~NetworkSerialLink () override

Private Attributes

ChunkCallback m_chunk
uint64_t m_endpoint { 0 }
Registry::Service::NetworkService * m_service
std::shared_ptr< Shared > m_shared
StateCallback m_state

Additional Inherited Members

Detailed Description

An ISerialLink over a SERIAL endpoint of the NetworkService.

The endpoint is opened with framing NONE, so every chunk the port yields reaches the chunk callback as it is. Reconnection, settle time and line control are the endpoint's, driven by the SerialLineSettings given to open(). The state callback also reports the endpoint's state at the moment open() returns, so a transition that happened before the callbacks were registered is not lost.

Without a service, open() fails.

Definition at line 23 of file NetworkSerialLink.hpp.


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