WiFiUDPZephyr Class Reference

WiFiUDP (Zephyr zsock version) This class provides a UDP interface using Zephyr's socket API (zsock). It mimics the Arduino WiFiUDP API for compatibility. More...

#include <WiFiUDPZephyr.h>

Public Member Functions
	WiFiUDPZephyr ()=default
	~WiFiUDPZephyr ()
int	available ()
int	availableForWrite ()
uint8_t	begin (uint16_t port)
uint8_t	beginMulticast (IPAddress multicast, uint16_t port)
	Join a multicast group and listen on the given port.
int	beginPacket (const char *host, uint16_t port)
int	beginPacket (IPAddress ip, uint16_t port)
	Begin a packet to an IPAddress (avoids implicit conversion issues)
int	endPacket ()
void	flush ()
const uint8_t *	getBuffer () const
	Direct pointer to internal RX buffer (NO COPY)
int	parsePacket ()
int	peek ()
int	read ()
int	read (uint8_t *dst, size_t len)
size_t	readBytes (uint8_t *dest, size_t len)
IPAddress	remoteIP () const
	Returns the remote IP as an IPAddress (Arduino-compatible)
char *	remoteIP (char *buf=nullptr)
	Fills buf with the dotted-decimal remote IP string; returns buf.
uint16_t	remotePort ()
void	stop ()
size_t	write (const uint8_t *data, size_t len)
size_t	write (uint8_t b)

Detailed Description

WiFiUDP (Zephyr zsock version) This class provides a UDP interface using Zephyr's socket API (zsock). It mimics the Arduino WiFiUDP API for compatibility.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

WiFiUDPZephyr()

WiFiUDPZephyr ( )

default

~WiFiUDPZephyr()

~WiFiUDPZephyr ( )

inline

Member Function Documentation

available()

int available ( )

inline

availableForWrite()

int availableForWrite ( )

inline

begin()

uint8_t begin ( uint16_t  port )

inline

beginMulticast()

uint8_t beginMulticast ( IPAddress  multicast, uint16_t  port  )

inline

Join a multicast group and listen on the given port.

Parameters

multicast	Multicast group address (e.g. IPAddress(239,0,0,1))
port	UDP port to bind to

Returns

1 on success, 0 on failure

beginPacket() [1/2]

int beginPacket ( const char *  host, uint16_t  port  )

inline

beginPacket() [2/2]

int beginPacket ( IPAddress  ip, uint16_t  port  )

inline

Begin a packet to an IPAddress (avoids implicit conversion issues)

endPacket()

int endPacket ( )

inline

flush()

void flush ( )

inline

getBuffer()

const uint8_t * getBuffer ( ) const

inline

Direct pointer to internal RX buffer (NO COPY)

parsePacket()

int parsePacket ( )

inline

peek()

int peek ( )

inline

read() [1/2]

int read ( )

inline

read() [2/2]

int read ( uint8_t *  dst, size_t  len  )

inline

readBytes()

size_t readBytes ( uint8_t *  dest, size_t  len  )

inline

remoteIP() [1/2]

IPAddress remoteIP ( ) const

inline

Returns the remote IP as an IPAddress (Arduino-compatible)

remoteIP() [2/2]

char * remoteIP ( char *  buf = nullptr )

inline

Fills buf with the dotted-decimal remote IP string; returns buf.

remotePort()

uint16_t remotePort ( )

inline

stop()

void stop ( )

inline

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inline

write() [2/2]

size_t write ( uint8_t  b )

inline

---

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

• src/AudioTools/Communication/Network/WiFiUDPZephyr.h