Shellminator  V1.1.1
Simple Terminal
Loading...
Searching...
No Matches
shellminatorWiFiClientChannel Class Reference

#include <Shellminator-IO.hpp>

Inheritance diagram for shellminatorWiFiClientChannel:
[legend]
Collaboration diagram for shellminatorWiFiClientChannel:
[legend]

Public Member Functions

void select (WiFiClient *client_p)
 Select WiFi Client. More...
 
int available () override
 Available bytes in the channel. More...
 
int read () override
 Read one byte form the channel. More...
 
int peek () override
 Peek the firtst byte from the channel. More...
 
void flush () override
 Flush the channel. More...
 
size_t write (uint8_t b) override
 Write one byte to the channel. More...
 
size_t print (char c) override
 Print one character to the channel. More...
 
size_t print (uint8_t b)
 Print one byte to the channel. More...
 
size_t print (char *str) override
 Print c-string to the channel. More...
 
size_t print (const char *str) override
 Print c-string to the channel. More...
 
WiFiClient * getClientObject ()
 Get the address of the chosen WiFi Client. More...
 
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...
 

Detailed Description

Definition at line 265 of file Shellminator-IO.hpp.

Member Function Documentation

◆ available()

int shellminatorWiFiClientChannel::available ( )
overridevirtual

Available bytes in the channel.

Returns
The available bytes in the channel.

Reimplemented from shellminatorChannel.

Definition at line 212 of file Shellminator-IO.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ flush()

void shellminatorWiFiClientChannel::flush ( )
overridevirtual

Flush the channel.

Reimplemented from shellminatorChannel.

Definition at line 233 of file Shellminator-IO.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getClientObject()

WiFiClient * shellminatorWiFiClientChannel::getClientObject ( )

Get the address of the chosen WiFi Client.

Returns
The address of the previously chosen WiFi Client object.

Definition at line 276 of file Shellminator-IO.cpp.

◆ peek()

int shellminatorWiFiClientChannel::peek ( )
overridevirtual

Peek the firtst byte from the channel.

Returns
Read and return one byte form the channel. The byte will NOT be removed from the channel.

Reimplemented from shellminatorChannel.

Definition at line 226 of file Shellminator-IO.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ print() [1/4]

size_t shellminatorWiFiClientChannel::print ( char *  str)
overridevirtual

Print c-string to the channel.

Parameters
strThe string that has to be printed to the channel.
Returns
The number of bytes that has been sucessfully printed to the channel. Because it is the base class, it returns 0.

Reimplemented from shellminatorChannel.

Definition at line 262 of file Shellminator-IO.cpp.

Here is the call graph for this function:

◆ print() [2/4]

size_t shellminatorWiFiClientChannel::print ( char  c)
overridevirtual

Print one character to the channel.

Parameters
cThe character that has to be printed to the channel.
Returns
The number of bytes that has been sucessfully printed to the channel. Because it is the base class, it returns 0.

Reimplemented from shellminatorChannel.

Definition at line 248 of file Shellminator-IO.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ print() [3/4]

size_t shellminatorWiFiClientChannel::print ( const char *  str)
overridevirtual

Print c-string to the channel.

Parameters
strThe string that has to be printed to the channel.
Returns
The number of bytes that has been sucessfully printed to the channel. Because it is the base class, it returns 0.

Reimplemented from shellminatorChannel.

Definition at line 269 of file Shellminator-IO.cpp.

Here is the call graph for this function:

◆ print() [4/4]

size_t shellminatorWiFiClientChannel::print ( uint8_t  b)
virtual

Print one byte to the channel.

Parameters
bThe value that has to be printed to the channel.
Returns
The number of bytes that has been sucessfully printed to the channel. Because it is the base class, it returns 0.

Reimplemented from shellminatorChannel.

Definition at line 255 of file Shellminator-IO.cpp.

Here is the call graph for this function:

◆ read()

int shellminatorWiFiClientChannel::read ( )
overridevirtual

Read one byte form the channel.

Returns
Read and return one byte form the channel. The byte will be removed from the channel.

Reimplemented from shellminatorChannel.

Definition at line 219 of file Shellminator-IO.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ select()

void shellminatorWiFiClientChannel::select ( WiFiClient *  client_p)

Select WiFi Client.

Select a WiFi Client to communicate with.

Note
This function has to be called before other memeber functions!

Definition at line 206 of file Shellminator-IO.cpp.

Here is the caller graph for this function:

◆ write()

size_t shellminatorWiFiClientChannel::write ( uint8_t  b)
overridevirtual

Write one byte to the channel.

Parameters
bThe value that has to be written to the channel.
Returns
The number of bytes that has been sucessfully written to the channel. Because it is the base class, it returns 0.

Reimplemented from shellminatorChannel.

Definition at line 239 of file Shellminator-IO.cpp.

Here is the call graph for this function:
Here is the caller graph for this function: