connect.h

Go to the documentation of this file.

#pragma once
 
 
#include "time.h"
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __unix__
    #include <netinet/in.h>
    #include <sys/socket.h>
#elif defined(_WIN32)
    #include <winsock2.h>
    #include <ws2tcpip.h>
#endif
 
 
typedef enum udipe_direction_e {
    UDIPE_IN = 0,
 
    UDIPE_OUT,
 
    UDIPE_INOUT
} udipe_direction_t;
 
typedef union ip_address_u {
    struct sockaddr any;  
    struct sockaddr_in v4;  
    struct sockaddr_in6 v6;  
} ip_address_t;
 
typedef enum udipe_bool_with_default_e {
    UDIPE_FALSE = 1,  
    UDIPE_TRUE = 2,  
    UDIPE_DEFAULT = 0,  
} udipe_bool_with_default_t;
 
typedef struct udipe_connect_options_s {
    //
    // TODO: Maps to SO_SNDTIMEO if set
    udipe_duration_ns_t send_timeout;
 
    //
    // TODO: Maps to SO_RCVTIMEO if set
    udipe_duration_ns_t recv_timeout;
 
    // TODO: Add `udipe_future_t* after` option to chain this after other ops.
 
    //
    // TODO: Maps to SO_BINDTODEVICE
    const char* local_interface;
 
    //
    // TODO: Provide a way to get that auto-assigned port after connection, this
    //       is done via getsockname().
    //
    // TODO: Maps to bind() if set + check type consistency with
    //       remote_address
    ip_address_t local_address;
 
    //
    // TODO: Maps to connect() if set + check type consistency with
    //       local_address
    ip_address_t remote_address;
 
    //
    // TODO: Implement by trying SO_SNDBUF then SO_SNDBUFFORCE
    unsigned send_buffer : 31;
 
    //
    // TODO: Implement by trying SO_RCVBUF then SO_RCVBUFFORCE
    unsigned recv_buffer : 31;
 
    //
    // TODO: Used to enforce usage validation by detecting invalid parameters
    //       and commands.
    udipe_direction_t direction;
 
    //
    // TODO: Sets UDP_SEGMENT in tandem with gso_segment_size
    udipe_bool_with_default_t enable_gso;
 
    //
    // TODO: Sets UDP_GRO
    udipe_bool_with_default_t enable_gro;
 
    //
    // TODO: Sets UDP_SEGMENT in tandem with enable_gso
    uint16_t gso_segment_size;
 
    //
    // TODO: Implement by setting SO_PRIORITY
    uint8_t priority;
 
    //
    // TODO: This will require SO_REUSEPORT + fancier infrastructure in
    //       udipe_context as a connexion may now be associated with multiple
    //       worker threads. In any case, udipe_context will need a way to know
    //       which worker threads can handle which connexion.
    bool allow_multithreading;
 
    //
    // TODO: Implement by setting SO_TIMESTAMPNS and checking the
    //       `SCM_TIMESTAMPNS` cmsg.
    bool enable_timestamps;
 
    // TODO: Activer aussi IP_RECVERR et logger voire gérer les erreurs, cf man
    //       7 ip pour plus d'infos. C'est aussi utilisé pour le zero-copy.
 
    // TODO: Activer périodiquement SO_RXQ_OVFL pour check l'overflow côté
    //       socket, puis le désactiver après réception du cmsg suivant.
 
    // TODO: Utiliser IP_MTU après binding pour autotuning de la segment size
    //       GRO, cf man 7 ip.
 
    // TODO: Dans udipe-config, creuser man 7 netdevice et man 7 rtnetlink pour
    //       la configuration device + check pseudofichiers mentionnés à la fin
    //       de man 7 socket, man 7 ip et man 7 udp pour la config kernel.
 
    // TODO: Quand j'aurai implémenté le multithreading des workers, utiliser
    //       SO_INCOMING_CPU pour associer le socket de chaque worker à son CPU.
} udipe_connect_options_t;
 
// TODO: Flesh out definitions, add docs
//
// TODO: Add max-size warnings in \internal, beware that they will not be the
//       same for options and results as for options we need to fit in the
//       internal command_t type.
typedef int udipe_connect_result_t;
typedef int udipe_disconnect_options_t;
typedef int udipe_disconnect_result_t;