lwip_raw_udp_impl.h

Go to the documentation of this file.

#pragma once
#include "esphome/core/defines.h"
 
#ifdef USE_SOCKET_IMPL_LWIP_TCP
 
#include <array>
#include <cstdint>
 
#include "headers.h"
#include "lwip/ip.h"
#include "lwip/udp.h"
 
namespace esphome::socket {
 
class LWIPRawUDPSendImpl {
 public:
  LWIPRawUDPSendImpl(sa_family_t family, struct udp_pcb *pcb) : pcb_(pcb), family_(family) {}
  ~LWIPRawUDPSendImpl();
  LWIPRawUDPSendImpl(const LWIPRawUDPSendImpl &) = delete;
  LWIPRawUDPSendImpl &operator=(const LWIPRawUDPSendImpl &) = delete;
 
  int bind(const struct sockaddr *name, socklen_t addrlen);
  int close();
 
  ssize_t sendto(const void *buf, size_t len, int flags, const struct sockaddr *dest_addr, socklen_t addrlen);
 
  int setsockopt(int level, int optname, const void *optval, socklen_t optlen);
  int getsockopt(int level, int optname, void *optval, socklen_t *optlen);
 
  int setblocking(bool blocking);
 
  bool ready() const { return false; }
  int get_fd() const { return -1; }
 
 protected:
  int ip2sockaddr_(const ip_addr_t *ip, uint16_t port, struct sockaddr *name, socklen_t *addrlen);
 
  int close_internal_locked_();
 
  struct udp_pcb *pcb_;
  sa_family_t family_;
};
 
class LWIPRawUDPImpl : private LWIPRawUDPSendImpl {
 public:
  LWIPRawUDPImpl(sa_family_t family, struct udp_pcb *pcb);
  ~LWIPRawUDPImpl();
 
  using LWIPRawUDPSendImpl::bind;
  using LWIPRawUDPSendImpl::get_fd;
  using LWIPRawUDPSendImpl::getsockopt;
  using LWIPRawUDPSendImpl::sendto;
  using LWIPRawUDPSendImpl::setblocking;
  using LWIPRawUDPSendImpl::setsockopt;
 
  int close();
 
  ssize_t read(void *buf, size_t len);
  ssize_t recvfrom(void *buf, size_t len, struct sockaddr *src_addr, socklen_t *addrlen);
 
  bool ready() const { return this->rx_count_ > 0; }
 
  uint16_t get_rx_dropped() const { return this->rx_dropped_; }
 
 protected:
  static void s_recv_fn(void *arg, struct udp_pcb *pcb, struct pbuf *p, const ip_addr_t *addr, u16_t port);
  void recv_fn_(struct pbuf *p, const ip_addr_t *addr, u16_t port);
 
  static constexpr uint8_t UDP_RX_QUEUE_SIZE = 4;
  static constexpr uint8_t UDP_RX_MASK = UDP_RX_QUEUE_SIZE - 1;
  static_assert((UDP_RX_QUEUE_SIZE & UDP_RX_MASK) == 0, "UDP_RX_QUEUE_SIZE must be power of 2");
  // Fields are written by recv_fn_ before rx_count_ makes a slot visible
  struct UDPRxPacket {
    ip_addr_t src_addr;
    struct pbuf *pb;
    uint16_t src_port;
  };
  std::array<UDPRxPacket, UDP_RX_QUEUE_SIZE> rx_queue_{};
  uint16_t rx_dropped_{0};
  uint8_t rx_read_idx_{0};
  uint8_t rx_count_{0};
};
 
}  // namespace esphome::socket
 
#endif  // USE_SOCKET_IMPL_LWIP_TCP