WiFiClientZephyr Class Reference

#include <WiFiClientZephyr.h>

Inheritance diagram for WiFiClientZephyr:

Public Member Functions
	WiFiClientZephyr ()=default
	Default constructor.
	WiFiClientZephyr (int socket)
	Constructor providing a socket (e.g. used by server)
virtual	~WiFiClientZephyr ()
int	available ()
virtual int	availableForWrite ()
virtual int	connect (const char *host, uint16_t port)
bool	connect (const char *ip, int port)
virtual int	connect (uint32_t ip, uint16_t port)
int	connected ()
int	fd () const
virtual void	flush ()
virtual	operator bool ()
int	peek ()
size_t	print (const char *str)
size_t	print (int value)
size_t	println (const char *str)
size_t	println (int value)
int	read ()
int	read (uint8_t *buf, size_t size)
virtual size_t	readBytes (uint8_t *data, size_t len)
void	setTimeout (uint32_t timeout_ms)
void	stop ()
size_t	write (const uint8_t *buf, size_t size)
size_t	write (uint8_t b)

Protected Member Functions
void	_applyTimeout ()
int	_resolve (const char *host, uint16_t port, struct sockaddr *out, socklen_t *outlen)

Protected Attributes
bool	_has_peek = false
uint8_t	_peek_byte = 0
int	_sock = -1
int	_timeout = 10
uint32_t	_timeout_ms = 5000

Detailed Description

WiFiClient-compatible TCP client for Zephyr RTOS. Header-only implementation — just include this file.

Required prj.conf: CONFIG_NETWORKING=y CONFIG_NET_TCP=y CONFIG_NET_SOCKETS=y CONFIG_DNS_RESOLVER=y

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

WiFiClientZephyr() [1/2]

WiFiClientZephyr ( )

default

Default constructor.

WiFiClientZephyr() [2/2]

WiFiClientZephyr ( int  socket )

inline

Constructor providing a socket (e.g. used by server)

~WiFiClientZephyr()

virtual ~WiFiClientZephyr ( )

inlinevirtual

Member Function Documentation

_applyTimeout()

void _applyTimeout ( )

inlineprotected

_resolve()

int _resolve ( const char *  host, uint16_t  port, struct sockaddr *  out, socklen_t *  outlen  )

inlineprotected

available()

int available ( )

inlinevirtual

Returns

Bytes available to read without blocking, -1 on error.

Reimplemented from Stream.

availableForWrite()

virtual int availableForWrite ( )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, AudioLoRa, RTSPOutput< Platform >, SPIAudioMaster, UDPStream, VBANStream, AudioStreamWrapper, ConverterStream< T >, LoRaStream, EncodedAudioOutput, EncodedAudioStream, FaustStream< DSP >, AudioFFTBase, FileOutput, I2SCodecStream, MiniAudioStream, StdioStream, A2DPStream, AudioServerEx, AudioSyncWriter, ESPNowStream, HammingFEC< bytecount, block_t >, AbstractURLStream, URLStreamESP32, NRF24Stream, ReadioHeadStream, ReedSolomonFEC< bytecount, additional_bytes >, SPIAudioSlave, USBAudioDeviceBase, SynchronizedStream, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, AdapterAudioStreamToAudioOutput, TimedStream, AudioOutput, CsvOutput< T >, OutputMixer< T >, MemoryOutput, PWMAudioOutput< PWMDriverT >, MemoryStream, RingBufferStream, MeasuringStream, ProgressStream, Throttle, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, BaseStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, Pipeline, QualityAnalysisStream, VolumeStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

connect() [1/3]

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

inlinevirtual

Open a TCP connection to host:port.

Parameters

host	Hostname or dotted-decimal IPv4/IPv6 string.
port	TCP port (host byte-order).

Returns

1 on success, 0 on failure (matches Arduino API).

Reimplemented in WiFiClientSecureZephyr.

connect() [2/3]

bool connect ( const char *  ip, int  port  )

inlineinherited

connect() [3/3]

virtual int connect ( uint32_t  ip, uint16_t  port  )

inlinevirtual

Open a TCP connection to a numeric IPv4 address.

Parameters

ip	IPv4 address as a 32-bit big-endian integer.
port	TCP port (host byte-order).

Returns

1 on success, 0 on failure.

Reimplemented in WiFiClientSecureZephyr.

connected()

int connected ( )

inline

Returns

Non-zero if the socket is connected.

fd()

int fd ( ) const

inline

Returns

The underlying Zephyr socket fd, or -1 if not open.

flush()

virtual void flush ( )

inlinevirtualinherited

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, ReformatBaseStream, MultiOutput, AudioOutput, AudioStreamWrapper, ResampleStream, EncodedAudioStream, HDLCStream, URLStream, BufferedTaskStream, I2SStream, HexDumpOutput, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, BaseStream, NamePrinter, VFSFile, and ZephyrFile.

operator bool()

virtual operator bool ( )

inlinevirtualinherited

peek()

int peek ( )

inline

Peek at the next byte without consuming it.

Returns

The byte (0–255), or -1 if unavailable.

print() [1/2]

size_t print ( const char *  str )

inline

print() [2/2]

size_t print ( int  value )

inline

println() [1/2]

size_t println ( const char *  str )

inline

println() [2/2]

size_t println ( int  value )

inline

read() [1/2]

int read ( )

inlinevirtual

Read a single byte.

Returns

The byte (0–255), or -1 on error / no data.

Reimplemented from Client.

read() [2/2]

int read ( uint8_t *  buf, size_t  size  )

inlinevirtual

Read up to size bytes into buf.

Returns

Bytes read, 0 on timeout/no-data, -1 on error.

Reimplemented from Client.

readBytes()

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlinevirtualinherited

Reimplemented in LMSEchoCancellationStream< T >, MDFEchoCancellationStream< Allocator >, USBAudioDeviceBase, HDLCStream, MozziStream, PureDataStream, AudioLoRa, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, AudioStreamWrapper, VFSFile, LoRaStream, EncodedAudioStream, FaustStream< DSP >, AudioFFTBase, AudioKitStream, AudioMP34DT05, I2SCodecStream, MiniAudioStream, PortAudioStream, StdioStream, TfLiteAudioStream, A2DPStream, AdaptiveResamplingStream, ESPNowStream, HammingFEC< bytecount, block_t >, HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, BufferedTaskStream, URLStreamESP32, NRF24Stream, ReadioHeadStream, ReedSolomonFEC< bytecount, additional_bytes >, SPIAudioSlave, UDPStream, VBANStream, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, TimedStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, MeasuringStream, ProgressStream, Throttle, InputMixer< T, SumT >, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, AudioStream, CatStream, NullStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, Pipeline, QualityAnalysisStream, VolumeStream, FileLoopT< FileType >, FileLoopT< File >, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, BaseStream, WM8960Stream, AnalogDriverESP32V1::IO16Bit, AnalogDriverESP32V2::IO16Bit, and HttpRequest.

setTimeout()

void setTimeout ( uint32_t  timeout_ms )

inline

Set the receive timeout (default: 5000 ms). Pass 0 to block indefinitely.

stop()

void stop ( )

inline

Close the connection and release the socket.

write() [1/2]

size_t write ( const uint8_t *  buf, size_t  size  )

inlinevirtual

Send a buffer.

Returns

Number of bytes actually sent.

Reimplemented from Print.

write() [2/2]

size_t write ( uint8_t  b )

inline

Send a single byte.

Returns

1 on success, 0 on failure.

Member Data Documentation

_has_peek

bool _has_peek = false

protected

_peek_byte

uint8_t _peek_byte = 0

protected

_sock

int _sock = -1

protected

_timeout

int _timeout = 10

protectedinherited

_timeout_ms

uint32_t _timeout_ms = 5000

protected

---

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

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