mn_net_types.hpp

Go to the documentation of this file.

/*
*This file is part of the Mini Thread Library (https://github.com/RoseLeBlood/MiniThread ).
*Copyright (c) 2018 Amber-Sophia Schroeck
*
*The Mini Thread Library is free software; you can redistribute it and/or modify
*it under the terms of the GNU Lesser General Public License as published by
*the Free Software Foundation, version 3, or (at your option) any later version.
 
*The Mini Thread Library is distributed in the hope that it will be useful, but
*WITHOUT ANY WARRANTY; without even the implied warranty of
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
*General Public License for more details.
*
*You should have received a copy of the GNU Lesser General Public
*License along with the Mini Thread  Library; if not, see
*<https://www.gnu.org/licenses/>.
*/
#ifndef _MINLIB_BASIC_NET_TYPES_HPP_
#define _MINLIB_BASIC_NET_TYPES_HPP_
 
#include "lwip/err.h"
#include "lwip/sockets.h"
 
#ifndef UDPLITE_SEND_CSCOV
#define UDPLITE_SEND_CSCOV 0x01
#endif // UDPLITE_SEND_CSCOV
 
#ifndef UDPLITE_RECV_CSCOV
#define UDPLITE_RECV_CSCOV 0x02
#endif // UDPLITE_RECV_CSCOV
 
#define SERVICE_PROVIDES_TOS(tos) (mn::net::service_provides) ((tos) & mn::net::service_provides::tos_mask)
 
namespace mn {
    namespace net {
 
        enum class address_family {
            Unspecified         = AF_UNSPEC,
            inet_v4             = AF_INET,
            inet_v6             = AF_INET6,
        };
 
        enum class protocol_type : int {
            unspec = IPPROTO_IP,
            icmp = IPPROTO_ICMP,
            tcp = IPPROTO_TCP,
            udp = IPPROTO_UDP,
        #if LWIP_IPV6 == 1
            icmpv6 = IPPROTO_ICMPV6,
        #endif // LWIP_IPV6
 
            udp_lite = IPPROTO_UDPLITE,
            raw = IPPROTO_RAW
        };
 
        enum class socket_type : int {
            stream = SOCK_STREAM,
            dgram = SOCK_DGRAM,
            raw = SOCK_RAW,
        };
        enum class socket_flags : int {
            none = 0x00,
            out_of_band = MSG_OOB,
            peek = MSG_PEEK,
            wait_all = MSG_WAITALL,
            non_blocking = MSG_DONTWAIT,
            more = MSG_MORE,
            no_signal = MSG_NOSIGNAL,
        };
        enum class socket_shutdown_type : uint8_t {
            read = SHUT_RD,
            write = SHUT_WR,
            rw = SHUT_RDWR
        };
        enum class socket_option_level : int {
            socket = SOL_SOCKET,
            ip = IPPROTO_IP,
        #if LWIP_IPV6 == 1
            ipv6 = (int)IPPROTO_IPV6,
        #endif // LWIP_IPV6
 
            tcp = (int)protocol_type::tcp,
            udp = (int)protocol_type::udp,
            udp_lite = (int)protocol_type::udp_lite,
 
        };
        enum class socket_option_name : int {
            debug = SO_DEBUG,
            acceptconn = SO_ACCEPTCONN,
            dont_route = SO_DONTROUTE,
            use_loopback = SO_USELOOPBACK,
            linger = SO_LINGER,
            nolinger = SO_DONTLINGER,
            oob_inline = SO_OOBINLINE,
            reuse_port = SO_REUSEPORT,
            reuse_addr = SO_REUSEADDR,
            sendbuffer = SO_SNDBUF,
            recivebuffer = SO_RCVBUF,
 
        #if LWIP_UDP == 1 && LWIP_UDPLITE == 1
            udplite_send_cscov = UDPLITE_SEND_CSCOV,
            udplite_recv_cscov = UDPLITE_RECV_CSCOV,
        #endif // LWIP_UDP
 
            send_lowat = SO_SNDLOWAT,
            recive_lowat = SO_RCVLOWAT,
            send_timeout = SO_SNDTIMEO,
            recive_timeout = SO_RCVTIMEO,
            error = SO_ERROR,
            get_type = SO_TYPE,
            commected_timeout = SO_CONTIMEO,
            no_check = SO_NO_CHECK,
            bind_device = SO_BINDTODEVICE,
            broadcast = SO_BROADCAST,
            keepalive = SO_KEEPALIVE,
 
 
            /*
             * @brief Type of Service (TOS) settings should only be set using the Quality of Service API.
             */
            tos = IP_TOS,
            /*
             * @brief Changes the default value set by the TCP/IP service provider in the TTL field of the IP
             * header in outgoing datagrams
             */
            ttl = IP_TTL,
 
 
        #if LWIP_TCP == 1
            tcp_nodelay = TCP_NODELAY,
            tcp_keepalive = TCP_KEEPALIVE,
            tcp_keepidle = TCP_KEEPIDLE,
            tcp_keepintvl = TCP_KEEPINTVL,
            tcp_keepcnt = TCP_KEEPCNT,
        #endif
 
        #ifdef LWIP_MULTICAST_TX_OPTIONS
            multicast_ttl = IP_MULTICAST_TTL,
            multicast_if = IP_MULTICAST_IF,
            multicast_loop = IP_MULTICAST_LOOP,
        #endif
 
        #if ESP_LWIP == 1 && LWIP_IPV6_MLD == 1
            multicast_ip6_if = IPV6_MULTICAST_IF,
            multicast_ip6_hops = IPV6_MULTICAST_HOPS,
            multicast_ip6_loop = IPV6_MULTICAST_LOOP,
            multicast_ip6_add_membership = IPV6_ADD_MEMBERSHIP,
            multicast_ip6_drop_membership = IPV6_DROP_MEMBERSHIP,
        #endif
 
        #if LWIP_IGMP == 1
            igmp_add_membership = IP_ADD_MEMBERSHIP,
            igmp_drop_membership = IP_DROP_MEMBERSHIP,
        #endif // LWIP_IGMP
        };
 
        enum service_provides {
            tos_mask = IPTOS_TOS_MASK,          
            low_delay = IPTOS_LOWDELAY,         
            through_put = IPTOS_THROUGHPUT,     
            reliability = IPTOS_RELIABILITY,    
            low_cost = IPTOS_LOWCOST,           
            min_cost = IPTOS_MINCOST,           
        };
        enum class ioctl_request_type  {
            available = FIONREAD,               
            non_blocking = FIONBIO,             
        };
 
 
    }
}
 
#endif