Class jac::RouterOutputStreamCommunicator

ClassList > jac > RouterOutputStreamCommunicator

Inherits the following classes: jac::OutputStreamCommunicator

Public Functions

Type	Name
	RouterOutputStreamCommunicator (Router & router, uint8_t channel, std::vector< int > links)
virtual bool	put (uint8_t c) override Put a single byte to the stream.
virtual void	setRecipients (std::vector< int > recipients) override Set the data links the stream should be sent to. Empty links for broadcast.
virtual size_t	write (std::span< const uint8_t > data) override Write a buffer to the stream.

Public Functions inherited from jac::OutputStreamCommunicator

See jac::OutputStreamCommunicator

Type	Name
	OutputStreamCommunicator () = default
	OutputStreamCommunicator (const OutputStreamCommunicator &) = delete
OutputStreamCommunicator &	operator= (const OutputStreamCommunicator &) = delete
virtual bool	put (uint8_t c) = 0 Put a single byte to the stream.
virtual void	setRecipients (std::vector< int > recipients) = 0 Set the data links the stream should be sent to. Empty links for broadcast.
virtual size_t	write (std::span< const uint8_t > data) = 0 Write a buffer to the stream.
virtual	~OutputStreamCommunicator () = default

Public Functions Documentation

function RouterOutputStreamCommunicator

inline jac::RouterOutputStreamCommunicator::RouterOutputStreamCommunicator (
    Router & router,
    uint8_t channel,
    std::vector< int > links
) 

function put

Put a single byte to the stream.

inline virtual bool jac::RouterOutputStreamCommunicator::put (
    uint8_t c
) override

Parameters:

• c the byte to put

Returns:

True if the byte was put successfully

Implements jac::OutputStreamCommunicator::put

function setRecipients

Set the data links the stream should be sent to. Empty links for broadcast.

inline virtual void jac::RouterOutputStreamCommunicator::setRecipients (
    std::vector< int > recipients
) override

Parameters:

• recipients the data link ids

Implements jac::OutputStreamCommunicator::setRecipients

function write

Write a buffer to the stream.

inline virtual size_t jac::RouterOutputStreamCommunicator::write (
    std::span< const uint8_t > data
) override

Parameters:

• data the buffer to write

Returns:

The number of bytes put

Implements jac::OutputStreamCommunicator::write

---

The documentation for this class was generated from the following file src/jac/link/routerCommunicator.h