unilink::wrapper::ChannelInterface Class Reference

Common interface for 1:1 point-to-point communication (e.g., TcpClient, Serial, Udp) More...

#include <ichannel.hpp>

Inheritance diagram for unilink::wrapper::ChannelInterface:

Public Types
using	MessageHandler = std::function< void(const MessageContext &)>
using	ConnectionHandler = std::function< void(const ConnectionContext &)>
using	ErrorHandler = std::function< void(const ErrorContext &)>

Public Member Functions
virtual	~ChannelInterface ()=default
virtual std::future< bool >	start ()=0
virtual void	stop ()=0
virtual bool	is_connected () const =0
virtual void	send (std::string_view data)=0
virtual void	send_line (std::string_view line)=0
virtual ChannelInterface &	on_data (MessageHandler handler)=0
virtual ChannelInterface &	on_connect (ConnectionHandler handler)=0
virtual ChannelInterface &	on_disconnect (ConnectionHandler handler)=0
virtual ChannelInterface &	on_error (ErrorHandler handler)=0
virtual ChannelInterface &	auto_manage (bool manage=true)=0

Detailed Description

Common interface for 1:1 point-to-point communication (e.g., TcpClient, Serial, Udp)

Definition at line 34 of file ichannel.hpp.

Member Typedef Documentation

ConnectionHandler

using unilink::wrapper::ChannelInterface::ConnectionHandler = std::function<void(const ConnectionContext&)>

Definition at line 37 of file ichannel.hpp.

ErrorHandler

using unilink::wrapper::ChannelInterface::ErrorHandler = std::function<void(const ErrorContext&)>

Definition at line 38 of file ichannel.hpp.

MessageHandler

using unilink::wrapper::ChannelInterface::MessageHandler = std::function<void(const MessageContext&)>

Definition at line 36 of file ichannel.hpp.

Constructor & Destructor Documentation

~ChannelInterface()

virtual unilink::wrapper::ChannelInterface::~ChannelInterface ( )

virtualdefault

Member Function Documentation

auto_manage()

virtual ChannelInterface& unilink::wrapper::ChannelInterface::auto_manage ( bool  manage = true )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

is_connected()

virtual bool unilink::wrapper::ChannelInterface::is_connected ( ) const

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

on_connect()

virtual ChannelInterface& unilink::wrapper::ChannelInterface::on_connect ( ConnectionHandler  handler )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

on_data()

virtual ChannelInterface& unilink::wrapper::ChannelInterface::on_data ( MessageHandler  handler )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

on_disconnect()

virtual ChannelInterface& unilink::wrapper::ChannelInterface::on_disconnect ( ConnectionHandler  handler )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

on_error()

virtual ChannelInterface& unilink::wrapper::ChannelInterface::on_error ( ErrorHandler  handler )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

send()

virtual void unilink::wrapper::ChannelInterface::send ( std::string_view  data )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

send_line()

virtual void unilink::wrapper::ChannelInterface::send_line ( std::string_view  line )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

start()

virtual std::future<bool> unilink::wrapper::ChannelInterface::start ( )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

stop()

virtual void unilink::wrapper::ChannelInterface::stop ( )

pure virtual

Implemented in unilink::wrapper::Udp, unilink::wrapper::TcpClient, and unilink::wrapper::Serial.

---

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

• unilink/wrapper/ichannel.hpp