RUI3 (RAK Unified Interface 3) - RAK4631
Clientabstract

Public Member Functions

virtual int connect (IPAddress ip, uint16_t port)=0
 
virtual int connect (const char *host, uint16_t port)=0
 
virtual size_t write (uint8_t)=0
 
virtual size_t write (const uint8_t *buf, size_t size)=0
 
virtual int available ()=0
 
virtual int read ()=0
 
virtual int read (uint8_t *buf, size_t size)=0
 
virtual int peek ()=0
 
virtual void flush ()=0
 
virtual void stop ()=0
 
virtual uint8_t connected ()=0
 
virtual operator bool ()=0
 
- Public Member Functions inherited from Stream
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 ()
 
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

uint8_t * rawIPAddress (IPAddress &addr)
 
- Protected Member Functions inherited from Stream
int timedRead ()
 
int findMulti (struct MultiTarget *targets, int tCount)
 
- Protected Member Functions inherited from Print
void setWriteError (int err=1)
 

Additional Inherited Members

- Protected Attributes inherited from Stream
unsigned long timeOut
 
unsigned long startTime
 

Member Function Documentation

◆ connect() [1/2]

virtual int connect ( IPAddress  ip,
uint16_t  port 
)
pure virtual

◆ connect() [2/2]

virtual int connect ( const char *  host,
uint16_t  port 
)
pure virtual

◆ write() [1/2]

virtual size_t write ( uint8_t  )
pure virtual

Implements Print.

◆ write() [2/2]

virtual size_t write ( const uint8_t *  buf,
size_t  size 
)
pure virtual

Reimplemented from Print.

◆ available()

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

Implements Stream.

◆ read() [1/2]

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

Implements Stream.

◆ read() [2/2]

virtual int read ( uint8_t *  buf,
size_t  size 
)
pure virtual

◆ peek()

virtual int peek ( )
pure virtual

Implements Stream.

◆ flush()

virtual void flush ( )
pure virtual

Implements Stream.

◆ stop()

virtual void stop ( )
pure virtual

◆ connected()

virtual uint8_t connected ( )
pure virtual

◆ operator bool()

virtual operator bool ( )
pure virtual

◆ rawIPAddress()

uint8_t* rawIPAddress ( IPAddress addr)
protected