arduino::WiFiUDPStream Class Reference

UDP Stream implementation for single-target communication. More...

#include <WiFiUdpStream.h>

Inheritance diagram for arduino::WiFiUDPStream:

Public Member Functions
	WiFiUDPStream (IPAddress targetAdress, int port)
void	flush ()
bool	isActive ()
size_t	readBytes (uint8_t *values, size_t len)
void	setTarget (IPAddress targetAdress, int port)
void	stop ()
bool	targetDefined ()
Public Member Functions inherited from arduino::EthernetUDP
int	available ()
uint8_t	begin (IPAddress a, uint16_t p)
uint8_t	begin (uint16_t p)
uint8_t	beginMulticast (IPAddress a, uint16_t p)
int	beginMulticastPacket ()
int	beginPacket ()
int	beginPacket (const char *host, uint16_t port)
int	beginPacket (IPAddress ip, uint16_t port)
int	endPacket ()
int	parsePacket ()
int	peek ()
int	read ()
int	read (char *buffer, size_t len)
int	read (unsigned char *buffer, size_t len)
IPAddress	remoteIP ()
uint16_t	remotePort ()
size_t	write (const uint8_t *buffer, size_t size)
size_t	write (uint8_t)
Public Member Functions inherited from arduino::Stream
bool	find (char target)
bool	find (const char *target)
bool	find (const char *target, size_t length)
bool	find (const uint8_t *target)
bool	find (const uint8_t *target, size_t length)
bool	findUntil (const char *target, const char *terminator)
bool	findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
bool	findUntil (const uint8_t *target, const char *terminator)
bool	findUntil (const uint8_t *target, size_t targetLen, const char *terminate, size_t termLen)
unsigned long	getTimeout (void)
float	parseFloat (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
long	parseInt (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
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)
void	setTimeout (unsigned long timeout)
Public Member Functions inherited from arduino::Print
virtual int	availableForWrite ()
void	clearWriteError ()
int	getWriteError ()
size_t	print (char)
size_t	print (const __FlashStringHelper *)
size_t	print (const char[])
size_t	print (const Printable &)
size_t	print (const String &)
size_t	print (double, int=2)
size_t	print (int, int=DEC)
size_t	print (long long, int=DEC)
size_t	print (long, int=DEC)
size_t	print (unsigned char, int=DEC)
size_t	print (unsigned int, int=DEC)
size_t	print (unsigned long long, int=DEC)
size_t	print (unsigned long, int=DEC)
size_t	println (char)
size_t	println (const __FlashStringHelper *)
size_t	println (const char[])
size_t	println (const Printable &)
size_t	println (const String &s)
size_t	println (double, int=2)
size_t	println (int, int=DEC)
size_t	println (long long, int=DEC)
size_t	println (long, int=DEC)
size_t	println (unsigned char, int=DEC)
size_t	println (unsigned int, int=DEC)
size_t	println (unsigned long long, int=DEC)
size_t	println (unsigned long, int=DEC)
size_t	println (void)
size_t	write (const char *buffer, size_t size)
size_t	write (const char *str)

Protected Attributes
bool	active = false
int	port = 0
IPAddress	target_adress {0, 0, 0, 0}
Protected Attributes inherited from arduino::Stream
unsigned long	_startMillis
unsigned long	_timeout

Additional Inherited Members
Protected Member Functions inherited from arduino::EthernetUDP
void	registerCleanup ()
Protected Member Functions inherited from arduino::UDP
uint8_t *	rawIPAddress (IPAddress &addr)
Protected Member Functions inherited from arduino::Stream
int	findMulti (struct MultiTarget *targets, int tCount)
float	parseFloat (char ignore)
long	parseInt (char ignore)
int	peekNextDigit (LookaheadMode lookahead, bool detectDecimal)
int	timedPeek ()
int	timedRead ()
Protected Member Functions inherited from arduino::Print
void	setWriteError (int err=1)

Detailed Description

UDP Stream implementation for single-target communication.

WiFiUDPStream extends WiFiUDP to provide a stream-like interface for UDP communication with a single target endpoint. It automatically manages packet boundaries and provides buffered read/write operations suitable for streaming protocols over UDP.

Key features:

• Stream-based UDP communication with automatic packet management
• Single target endpoint configuration (IP address and port)
• Automatic target discovery from incoming packets when target unknown
• Buffered operations with flush-triggered packet transmission
• Thread-safe operations for concurrent access
• Integration with WiFiUDP for underlying network operations

The class maintains an internal target address and automatically begins/ends UDP packets as needed. Data is sent when flush() is called, making it suitable for protocols that require message boundaries or batch transmission.

See also

WiFiUDP

IPAddress

Stream

Member Function Documentation

flush()

void arduino::WiFiUDPStream::flush ( void  )

inlinevirtual

Reimplemented from arduino::EthernetUDP.

stop()

void arduino::WiFiUDPStream::stop ( )

inlinevirtual

Reimplemented from arduino::EthernetUDP.

---

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

• ArduinoCore-Linux/cores/arduino/WiFiUdpStream.h