idfxx 1.0.0
Modern C++23 components for ESP-IDF
Loading...
Searching...
No Matches

Namespaces

namespace  detail
 

Classes

class  buffer
 Owning handle for a netconn buffer. More...
 
class  datagram_channel
 A UDP netconn channel. More...
 
class  listener
 A TCP listening netconn. More...
 
class  raw_channel
 A raw IP netconn channel. More...
 
class  stream_channel
 A TCP netconn channel. More...
 

Enumerations

enum class  udp_variant : int {
  standard ,
  lite ,
  no_checksum
}
 UDP transport variant for datagram netconn channels. More...
 
enum class  write_flag : uint8_t {
  no_copy = 0x01 ,
  more = 0x02 ,
  dont_block = 0x04
}
 Flags accepted by stream_channel::send / try_send. More...
 

Enumeration Type Documentation

◆ udp_variant

UDP transport variant for datagram netconn channels.

Most UDP traffic uses standard (with checksums). The lite and no_checksum variants are specialized — only set them if you know your peer expects the corresponding wire format.

Enumerator
standard 

Standard UDP.

lite 

UDP-Lite (RFC 3828).

no_checksum 

UDP with checksums disabled.

Definition at line 38 of file datagram_channel.hpp.

◆ write_flag

Flags accepted by stream_channel::send / try_send.

The default (no flags set) copies the data into the stack's buffers, so the caller may reuse or destroy its buffer as soon as the call returns. Set no_copy to reference the caller's buffer instead — see the lifetime warning on that flag.

Enumerator
no_copy 

Zero-copy: reference the caller's buffer rather than copying it.

Warning
The referenced memory must remain valid not just until the call returns, but until the data has been transmitted and acknowledged by the peer — try_send returns once the data is enqueued, while the stack continues to hold the reference for retransmission. Use only for storage that outlives the connection (e.g. static or flash-resident data); never for stack or soon-freed buffers.
more 

Suppress the TCP PSH flag (allow more data to be coalesced).

dont_block 

Return immediately rather than waiting for buffer space.

Definition at line 41 of file stream_channel.hpp.