io_writeable.h File Reference

Detailed Description

"Writeable" I/O interface core definitions

The core of all SatCat5 I/O are the "Writeable" interface (io_writeable.h) and "Readable" interface (io_readable.h). These general-purpose virtual interfaces are used by PacketBuffer, generic UARTs, etc. for code reuse.

Definition in file io_writeable.h.

#include <satcat5/types.h>

Include dependency graph for io_writeable.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	satcat5::io::Writeable
	Abstract API for writing byte-streams and packets. More...
class	satcat5::io::ArrayWrite
	Ephemeral Writeable interface for a simple array. More...
class	satcat5::io::ArrayWriteStatic< SIZE >
	Thin wrapper for ArrayWrite with a built-in buffer. More...
class	satcat5::io::LimitedWrite
	Limited write up to N bytes. More...
class	satcat5::io::WriteableRedirect
	Wrapper class for forwarding writes to another object. More...
class	satcat5::io::NullWrite
	Writeable object that accepts and discards all incoming data. More...

Variables
satcat5::io::NullWrite	satcat5::io::null_write
	Global instance of the basic NullWrite object. More...

Variable Documentation

null_write

NullWrite satcat5::io::null_write

extern

Global instance of the basic NullWrite object.

Use this placeholder instead of a null pointer.