sock.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Alexander Aring <aar@pengutronix.de>
 * SPDX-FileCopyrightText: 2016 Freie Universität Berlin
 * SPDX-FileCopyrightText: 2016 HAW Hamburg
 * SPDX-FileCopyrightText: 2016 Kaspar Schleiser <kaspar@schleiser.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include <stdint.h>
#include <stddef.h>
#include "iolist.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(DOXYGEN)
#define SOCK_HAS_IPV6       
#define SOCK_HAS_ASYNC
#define SOCK_HAS_ASYNC_CTX
#endif
 
#define SOCK_FLAGS_REUSE_EP         (0x0001)    
#define SOCK_FLAGS_CONNECT_REMOTE   (0x0002)    
#define SOCK_ADDR_ANY_NETIF (0)
 
#define SOCK_IPV4_EP_ANY        { .family = AF_INET, \
                                  .netif = SOCK_ADDR_ANY_NETIF }
 
#if defined(SOCK_HAS_IPV6) || defined(DOXYGEN)
#define SOCK_IPV6_EP_ANY        { .family = AF_INET6, \
                                  .netif = SOCK_ADDR_ANY_NETIF }
#endif
 
#define SOCK_NO_TIMEOUT     (UINT32_MAX)
 
typedef struct {
    int family;
 
    union {
#ifdef SOCK_HAS_IPV6
        uint8_t ipv6[16];
#endif
        uint8_t ipv4[4];        
        uint32_t ipv4_u32;      
    } addr;                 
    uint16_t netif;
} sock_ip_ep_t;
 
struct _sock_tl_ep {
    int family;
 
    union {
#ifdef SOCK_HAS_IPV6
        uint8_t ipv6[16];
#endif
        uint8_t ipv4[4];        
        uint32_t ipv4_u32;      
    } addr;                 
    uint16_t netif;
    uint16_t port;          
};
 
enum {
    SOCK_AUX_GET_LOCAL = (1LU << 0),
    SOCK_AUX_GET_TIMESTAMP = (1LU << 1),
    SOCK_AUX_GET_RSSI = (1LU << 2),
    SOCK_AUX_SET_LOCAL = (1LU << 3),
    SOCK_AUX_GET_TTL = (1LU << 4),
};
 
typedef uint8_t sock_aux_flags_t;
 
#ifdef __cplusplus
}
#endif