platform_net.h

Go to the documentation of this file.

#ifndef NROS_PLATFORM_NET_H
#define NROS_PLATFORM_NET_H
 
#include <stdint.h>
#include <stddef.h>
 
#include "nros/platform.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NROS_PLATFORM_NET_SOCKET_ERROR ((size_t) -1)
 
/* ---- TCP ---- */
 
int8_t nros_platform_tcp_create_endpoint(void *ep,
                                         const uint8_t *address,
                                         const uint8_t *port);
 
void nros_platform_tcp_free_endpoint(void *ep);
 
int8_t nros_platform_tcp_open(void *sock, const void *endpoint, uint32_t timeout_ms);
 
int8_t nros_platform_tcp_listen(void *sock, const void *endpoint);
 
void nros_platform_tcp_close(void *sock);
 
size_t nros_platform_tcp_read(const void *sock, uint8_t *buf, size_t len);
 
size_t nros_platform_tcp_read_exact(const void *sock, uint8_t *buf, size_t len);
 
size_t nros_platform_tcp_send(const void *sock, const uint8_t *buf, size_t len);
 
/* ---- UDP unicast ---- */
 
int8_t nros_platform_udp_create_endpoint(void *ep,
                                         const uint8_t *address,
                                         const uint8_t *port);
void   nros_platform_udp_free_endpoint(void *ep);
int8_t nros_platform_udp_open(void *sock, const void *endpoint, uint32_t timeout_ms);
 
int8_t nros_platform_udp_listen(void *sock, const void *endpoint, uint32_t timeout_ms);
 
void   nros_platform_udp_close(void *sock);
size_t nros_platform_udp_read(const void *sock, uint8_t *buf, size_t len);
size_t nros_platform_udp_read_exact(const void *sock, uint8_t *buf, size_t len);
 
size_t nros_platform_udp_send(const void *sock,
                              const uint8_t *buf, size_t len,
                              const void *endpoint);
 
void nros_platform_udp_set_recv_timeout(const void *sock, uint32_t timeout_ms);
 
/* ---- UDP multicast (optional) ----
 *
 * Signatures mirror the Rust `PlatformUdpMulticast` trait. `lep`
 * is the local-endpoint storage (caller-allocated); `iface` /
 * `join` are NUL-terminated strings naming the network interface
 * and the multicast group to join.
 */
 
int8_t nros_platform_udp_mcast_open(void *sock,
                                    const void *endpoint,
                                    void *lep,
                                    uint32_t timeout_ms,
                                    const uint8_t *iface);
 
int8_t nros_platform_udp_mcast_listen(void *sock,
                                      const void *endpoint,
                                      uint32_t timeout_ms,
                                      const uint8_t *iface,
                                      const uint8_t *join);
 
void nros_platform_udp_mcast_close(void *sockrecv,
                                   void *socksend,
                                   const void *rep,
                                   const void *lep);
 
size_t nros_platform_udp_mcast_read(const void *sock,
                                    uint8_t *buf, size_t len,
                                    const void *lep,
                                    void *addr);
 
size_t nros_platform_udp_mcast_read_exact(const void *sock,
                                          uint8_t *buf, size_t len,
                                          const void *lep,
                                          void *addr);
 
size_t nros_platform_udp_mcast_send(const void *sock,
                                    const uint8_t *buf, size_t len,
                                    const void *endpoint);
 
/* ---- Socket helpers ---- */
 
int8_t nros_platform_socket_set_non_blocking(const void *sock);
 
int8_t nros_platform_socket_accept(const void *sock_in, void *sock_out);
 
void nros_platform_socket_close(void *sock);
 
int8_t nros_platform_socket_wait_event(void *peers, void *mutex);
 
/* ---- Network poll (bare-metal / non-OS stacks) ---- */
 
void nros_platform_network_poll(void);
 
/* ---- Socket accessor (Phase 154) ---- *
 *
 * Every `nros_platform_*` backend stores its socket struct with
 * `int fd` (or equivalent) at offset 0:
 *
 *   - POSIX:        `typedef struct { int fd; } nros_posix_socket_t;`
 *   - ThreadX:      `typedef struct { INT fd; } nros_threadx_socket_t;`
 *   - FreeRTOS+lwIP same shape.
 *
 * This accessor lets callers (e.g. zpico-sys's `get_session_fd`
 * helper used by the read-task wakeup path on ThreadX-Linux) read
 * the fd without depending on the per-RTOS struct typedef being
 * visible at compile time. Static-inline so it has zero call
 * overhead and ships with the header — no extra TU to link.
 *
 * Returns -1 if `sock` is NULL. Otherwise returns the leading
 * `int` (which platforms treat as -1 for an unbound socket).
 */
static inline int nros_platform_socket_get_fd(const void *sock) {
    if (sock == NULL) { return -1; }
    /* SAFETY: every backend's socket struct is `{ int fd; ... }`,
     * so the first sizeof(int) bytes of the opaque storage are
     * the BSD-style fd. Cast-to-int read is the canonical way to
     * extract it. */
    return *(const int *)sock;
}
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* NROS_PLATFORM_NET_H */