ersa::hal::IConsole Class Reference

#include <console.h>

Inheritance diagram for ersa::hal::IConsole:

Public Member Functions
virtual	~IConsole ()=default
virtual void	begin (uint32_t baudRate)=0
virtual bool	isAttached () const =0
virtual size_t	availableForWrite () const =0
virtual size_t	available () const =0
virtual int	read ()=0
virtual size_t	write (const uint8_t *data, size_t length)=0
virtual void	flush ()=0

Detailed Description

Non-blocking byte console used for diagnostics and the host control bridge.

Constructor & Destructor Documentation

~IConsole()

virtual ersa::hal::IConsole::~IConsole ( )

virtualdefault

Member Function Documentation

available()

virtual size_t ersa::hal::IConsole::available ( ) const

pure virtual

Return the number of input bytes ready to consume.

Implemented in ersa::test::MockConsole.

availableForWrite()

virtual size_t ersa::hal::IConsole::availableForWrite ( ) const

pure virtual

Return the amount of output accepted without blocking.

Implemented in ersa::test::MockConsole.

begin()

virtual void ersa::hal::IConsole::begin ( uint32_t  baudRate )

pure virtual

Configure the selected platform console before emitting logs.

Implemented in ersa::test::MockConsole.

flush()

virtual void ersa::hal::IConsole::flush ( )

pure virtual

Flush pending output when the caller explicitly requests it.

Implemented in ersa::test::MockConsole.

isAttached()

virtual bool ersa::hal::IConsole::isAttached ( ) const

pure virtual

Report whether a host is attached to the console transport.

Implemented in ersa::test::MockConsole.

read()

virtual int ersa::hal::IConsole::read ( )

pure virtual

Read one byte or return a negative value if none is available.

Implemented in ersa::test::MockConsole.

write()

virtual size_t ersa::hal::IConsole::write ( const uint8_t *  data, size_t  length  )

pure virtual

Write as many bytes as the platform can accept immediately.

Implemented in ersa::test::MockConsole.

---

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

• include/ersa/hal/console.h