RUI3 (RAK Unified Interface 3) - RAK4631
Streamabstract

Data Structures

struct  MultiTarget
 

Public Member Functions

virtual void flush ()=0
 
virtual int peek ()=0
 
virtual int available ()=0
 
virtual int read ()=0
 
void setTimeout (unsigned long timeout)
 
unsigned long getTimeout (void)
 
size_t readBytes (char *buffer, size_t length)
 
size_t readBytes (uint8_t *buffer, size_t length)
 
size_t readBytesUntil (char terminator, char *buffer, size_t length)
 
size_t readBytesUntil (char terminator, uint8_t *buffer, size_t length)
 
String readString ()
 
String readStringUntil (char terminator)
 
bool find (const char *target)
 
bool find (const uint8_t *target)
 
bool find (const char *target, size_t length)
 
bool find (const uint8_t *target, size_t length)
 
bool find (char target)
 
bool findUntil (const char *target, const char *terminator)
 
bool findUntil (const uint8_t *target, const char *terminator)
 
bool findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
 
bool findUntil (const uint8_t *target, size_t targetLen, const char *terminate, size_t termLen)
 
- Public Member Functions inherited from Print
 Print ()
 
int getWriteError ()
 
void clearWriteError ()
 
virtual size_t write (uint8_t)=0
 
virtual size_t write (const uint8_t *, size_t size)
 
size_t write (const char *str)
 
size_t write (const char *buffer, size_t size)
 
size_t write (String str)
 
size_t print (const __FlashStringHelper *)
 
size_t print (const char *)
 
size_t print (const String &)
 
size_t print (char[])
 
size_t print (char)
 
size_t print (unsigned char, int=DEC)
 
size_t print (int, int=DEC)
 
size_t print (unsigned int, int=DEC)
 
size_t print (long, int=DEC)
 
size_t print (unsigned long, int=DEC)
 
size_t print (double, int=2)
 
size_t println (const __FlashStringHelper *)
 
size_t println (const char *)
 
size_t println (const String &s)
 
size_t println (char[])
 
size_t println (char)
 
size_t println (unsigned char, int=DEC)
 
size_t println (int, int=DEC)
 
size_t println (unsigned int, int=DEC)
 
size_t println (long, int=DEC)
 
size_t println (unsigned long, int=DEC)
 
size_t println (double, int=2)
 
size_t println (void)
 
void println (int64_t, uint8_t=DEC)
 
void print (int64_t, uint8_t=DEC)
 
void println (uint64_t, uint8_t=DEC)
 
void print (uint64_t, uint8_t=DEC)
 
size_t printf (const char *val,...)
 

Protected Member Functions

int timedRead ()
 
int findMulti (struct MultiTarget *targets, int tCount)
 
- Protected Member Functions inherited from Print
void setWriteError (int err=1)
 

Protected Attributes

unsigned long timeOut
 
unsigned long startTime
 

Member Function Documentation

◆ timedRead()

int timedRead ( )
protected

◆ findMulti()

int findMulti ( struct MultiTarget targets,
int  tCount 
)
protected

◆ flush()

virtual void flush ( )
pure virtual

Implemented in HardwareSerial, TwoWire, UDP, and Client.

◆ peek()

virtual int peek ( )
pure virtual

Implemented in HardwareSerial, TwoWire, UDP, and Client.

◆ available()

virtual int available ( )
pure virtual
Note
See detail in HardwareSerial.h

Implemented in HardwareSerial, TwoWire, UDP, and Client.

◆ read()

virtual int read ( )
pure virtual
Note
See detail in HardwareSerial.h

Implemented in HardwareSerial, TwoWire, UDP, and Client.

◆ readBytes()

size_t readBytes ( uint8_t *  buffer,
size_t  length 
)

◆ readBytesUntil()

size_t readBytesUntil ( char  terminator,
uint8_t *  buffer,
size_t  length 
)

◆ find() [1/5]

bool find ( const char *  target)

◆ find() [2/5]

bool find ( const uint8_t *  target)

◆ find() [3/5]

bool find ( const char *  target,
size_t  length 
)

◆ find() [4/5]

bool find ( const uint8_t *  target,
size_t  length 
)

◆ find() [5/5]

bool find ( char  target)

◆ findUntil() [1/4]

bool findUntil ( const char *  target,
const char *  terminator 
)

◆ findUntil() [2/4]

bool findUntil ( const uint8_t *  target,
const char *  terminator 
)

◆ findUntil() [3/4]

bool findUntil ( const char *  target,
size_t  targetLen,
const char *  terminate,
size_t  termLen 
)

◆ findUntil() [4/4]

bool findUntil ( const uint8_t *  target,
size_t  targetLen,
const char *  terminate,
size_t  termLen 
)

Field Documentation

◆ timeOut

unsigned long timeOut
protected

◆ startTime

unsigned long startTime
protected