![]() |
Shellminator
V1.1.1
Simple Terminal
|
Shellminator channel class. More...
#include <Shellminator-IO.hpp>
Public Member Functions | |
virtual int | available () |
Available bytes in the channel. More... | |
virtual int | read () |
Read one byte form the channel. More... | |
virtual int | peek () |
Peek the firtst byte from the channel. More... | |
virtual void | flush () |
Flush the channel. More... | |
virtual size_t | write (uint8_t b) |
Write one byte to the channel. More... | |
virtual size_t | print (char c) |
Print one character to the channel. More... | |
virtual size_t | print (uint8_t b) |
Print one byte to the channel. More... | |
virtual size_t | print (char *str) |
Print c-string to the channel. More... | |
virtual size_t | print (const char *str) |
Print c-string to the channel. More... | |
Shellminator channel class.
Shellminator uses channels to communicate with external peripherials like Serial port or WiFi Client. To make it easy to change the communication source, virtual functions are used. This is the base class for these virtual functions, and they don't do anytging usefull. To make them work, every function in this class has to be overrided to every peripherial, where it has to be used.
Definition at line 63 of file Shellminator-IO.hpp.
|
inlinevirtual |
Available bytes in the channel.
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 70 of file Shellminator-IO.hpp.
|
inlinevirtual |
Flush the channel.
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 83 of file Shellminator-IO.hpp.
|
inlinevirtual |
Peek the firtst byte from the channel.
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 80 of file Shellminator-IO.hpp.
|
inlinevirtual |
Print c-string to the channel.
str | The string that has to be printed to the channel. |
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 107 of file Shellminator-IO.hpp.
|
inlinevirtual |
Print one character to the channel.
c | The character that has to be printed to the channel. |
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 95 of file Shellminator-IO.hpp.
|
inlinevirtual |
Print c-string to the channel.
str | The string that has to be printed to the channel. |
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 113 of file Shellminator-IO.hpp.
|
inlinevirtual |
Print one byte to the channel.
b | The value that has to be printed to the channel. |
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 101 of file Shellminator-IO.hpp.
|
inlinevirtual |
Read one byte form the channel.
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 75 of file Shellminator-IO.hpp.
|
inlinevirtual |
Write one byte to the channel.
b | The value that has to be written to the channel. |
Reimplemented in shellminatorArduinoSerialChannel, shellminatorArduino32U4SerialChannel, and shellminatorWiFiClientChannel.
Definition at line 89 of file Shellminator-IO.hpp.