fnet_socket.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community
*
***************************************************************************
*
*  Licensed under the Apache License, Version 2.0 (the "License"); you may
*  not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*  http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
*  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***************************************************************************
*
*  Socket API.
*
***************************************************************************/

#ifndef _FNET_SOCKET_H_

#define _FNET_SOCKET_H_

#include "fnet_ip4.h"
#include "fnet_ip6.h"

/* Special addresses */

/**************************************************************************/ 
#define INADDR_ANY       (fnet_ip4_addr_t)(0x00000000U)

/**************************************************************************/ 
#define INADDR_BROADCAST (fnet_ip4_addr_t)(0xffffffffU)

/**************************************************************************/ 
typedef fnet_uint16_t fnet_address_family_t;

/**************************************************************************/ 
typedef fnet_uint32_t   fnet_scope_id_t;

/**************************************************************************/ 
#define AF_UNSPEC   (0U)
/**************************************************************************/ 
#define AF_INET     (1U)
/**************************************************************************/ 
#define AF_INET6    (2U)
/**************************************************************************/ 
#define AF_SUPPORTED ((fnet_address_family_t)((fnet_address_family_t)(AF_INET6*(fnet_address_family_t)FNET_CFG_IP6) | (fnet_address_family_t)(AF_INET*(fnet_address_family_t)FNET_CFG_IP4)))

/**************************************************************************/ 
#if FNET_CFG_IP6
    #define FNET_SA_DATA_SIZE       (sizeof(struct fnet_in6_addr))
#else /* IPv4 */
    #define FNET_SA_DATA_SIZE       (sizeof(struct fnet_in_addr))
#endif

/**************************************************************************/ 
#if FNET_CFG_IP6
    #define FNET_IP_ADDR_STR_SIZE       FNET_IP6_ADDR_STR_SIZE
#else /* IPv4 */
    #define FNET_IP_ADDR_STR_SIZE       FNET_IP4_ADDR_STR_SIZE
#endif

#define FNET_IP_ADDR_STR_SIZE_MAX       FNET_IP6_ADDR_STR_SIZE

/**************************************************************************/ 
struct fnet_in_addr
{
    fnet_ip4_addr_t s_addr; 
};

/**************************************************************************/ 
struct fnet_sockaddr_in
{
    fnet_address_family_t   sin_family;     
    fnet_uint16_t           sin_port;       
    fnet_scope_id_t         sin_scope_id;   
    struct fnet_in_addr     sin_addr;       
};


/************************************************************************
*                           IPv6
*************************************************************************/


/**************************************************************************/ 
struct fnet_in6_addr
{
    fnet_ip6_addr_t s6_addr;        
};

/**************************************************************************/ 
struct fnet_sockaddr_in6
{
    fnet_address_family_t   sin6_family;    
    fnet_uint16_t           sin6_port;      
    fnet_scope_id_t         sin6_scope_id;  
    struct fnet_in6_addr    sin6_addr;      
};

/**************************************************************************/ 
struct fnet_sockaddr
{
    fnet_address_family_t   sa_family;      
    fnet_uint16_t           sa_port;        
    fnet_scope_id_t         sa_scope_id;    
    fnet_uint8_t            sa_data[FNET_SA_DATA_SIZE];
};

/**************************************************************************/ 
struct fnet_ip_mreq
{
    struct fnet_in_addr imr_multiaddr;      
    fnet_scope_id_t     imr_interface;      
};

/**************************************************************************/ 
struct fnet_ipv6_mreq
{
    struct fnet_in6_addr    ipv6imr_multiaddr;  
    fnet_scope_id_t         ipv6imr_interface;  
};

/**************************************************************************/ 
typedef enum
{
    SOCK_UNSPEC = (0U),  
    SOCK_STREAM = (1U),  
    SOCK_DGRAM  = (2U),  
    SOCK_RAW    = (3U)   
} fnet_socket_type_t;

/**************************************************************************/ 
typedef enum
{
    SS_CLOSED = (0),    
    SS_CLOSING,         
    SS_CONNECTING,      
    SS_CONNECTED,       
    SS_LISTENING        
} fnet_socket_state_t;

/**************************************************************************/ 
typedef enum
{
    IPPROTO_IP      = (0), 
    IPPROTO_ICMP    = (1), 
    IPPROTO_IGMP    = (2), 
    IPPROTO_TCP     = (6), 
    IPPROTO_UDP     = (17),
    IPPROTO_IPV6    = (41), 
    IPPROTO_ICMPV6  = (58),
    SOL_SOCKET      = (255255)  
} fnet_protocol_t;

/**************************************************************************/ 
typedef enum
{
    SO_ACCEPTCONN,              
    SO_KEEPALIVE,               
    SO_DONTROUTE,               
    SO_LINGER,                  
    SO_OOBINLINE,               
    SO_SNDBUF,                  
    SO_RCVBUF,                  
    SO_STATE,                   
    SO_ERROR,                   
    SO_TYPE,                    
    SO_RCVNUM,                  
    SO_SNDNUM,                  
    SO_LISTENQLIMIT,            
    SO_LISTENQLEN,              
    /* TCP level (IPPROTO_TCP) options */

    TCP_MSS,                
    TCP_BSD,                
    TCP_NODELAY,            
    TCP_FINRCVD,            
    TCP_URGRCVD,            
    TCP_KEEPIDLE,           
    TCP_KEEPINTVL,          
    TCP_KEEPCNT,            
    /* IPv4 level (IPPROTO_IP) options */

    IP_TOS,                 
    IP_TTL,                 
    IP_MULTICAST_TTL,       
    IP_ADD_MEMBERSHIP,      
    IP_DROP_MEMBERSHIP,     
    /* IPv6 level (IPPROTO_IPV6) options */

    IPV6_UNICAST_HOPS,      
    IPV6_MULTICAST_HOPS,    
    IPV6_JOIN_GROUP,        
    IPV6_LEAVE_GROUP        
} fnet_socket_options_t;

/**************************************************************************/ 
struct fnet_linger
{
    fnet_bool_t    l_onoff;  
    fnet_uint16_t  l_linger; 
};

/**************************************************************************/ 
typedef void *fnet_socket_t;

/**************************************************************************/ 
typedef enum
{
    MSG_OOB       = (0x1U),  
    MSG_PEEK      = (0x2U),  
    MSG_DONTROUTE = (0x4U)   
} fnet_msg_flags_t;

/**************************************************************************/ 
typedef enum
{
    SD_READ  = (0x1U), 
    SD_WRITE = (0x2U), 
    SD_BOTH  = (SD_READ | SD_WRITE) 
} fnet_sd_flags_t;

/**************************************************************************/ 
typedef enum
{
    FNET_SOCKET_EVENT_NONE = 0,    
    FNET_SOCKET_EVENT_IN =  1 << 0, 
    FNET_SOCKET_EVENT_OUT = 1 << 1,  
    FNET_SOCKET_EVENT_ERR = 1 << 2,  
    FNET_SOCKET_EVENT_ALL = FNET_SOCKET_EVENT_IN | FNET_SOCKET_EVENT_OUT | FNET_SOCKET_EVENT_ERR 
} fnet_socket_event_t;

/**************************************************************************/ 
typedef struct
{
    fnet_socket_t          s;                      
    fnet_socket_event_t    events;                 
    fnet_socket_event_t    events_occurred;        
} fnet_socket_poll_t;


#if defined(__cplusplus)
extern "C" {
#endif

/***************************************************************************/ 
fnet_socket_t fnet_socket( fnet_address_family_t family, fnet_socket_type_t type, fnet_uint32_t protocol );

/***************************************************************************/ 
fnet_return_t fnet_socket_bind( fnet_socket_t s, const struct fnet_sockaddr *name, fnet_size_t namelen );

/***************************************************************************/ 
fnet_return_t fnet_socket_listen( fnet_socket_t s, fnet_size_t backlog );

/***************************************************************************/ 
fnet_socket_t fnet_socket_accept( fnet_socket_t s, struct fnet_sockaddr *addr, fnet_size_t *addrlen );

/***************************************************************************/ 
fnet_return_t fnet_socket_connect( fnet_socket_t s, struct fnet_sockaddr *name, fnet_size_t namelen );

/***************************************************************************/ 
fnet_ssize_t fnet_socket_recv( fnet_socket_t s, void *buf, fnet_size_t len, fnet_flag_t flags );

/***************************************************************************/ 
fnet_ssize_t fnet_socket_recvfrom( fnet_socket_t s, void *buf, fnet_size_t len, fnet_flag_t flags, struct fnet_sockaddr *from, fnet_size_t *fromlen );

/***************************************************************************/ 
fnet_ssize_t fnet_socket_send( fnet_socket_t s, const void *buf, fnet_size_t len, fnet_flag_t flags );

/***************************************************************************/ 
fnet_ssize_t fnet_socket_sendto( fnet_socket_t s, const void *buf, fnet_size_t len, fnet_flag_t flags, const struct fnet_sockaddr *to, fnet_size_t tolen );

/***************************************************************************/ 
fnet_return_t fnet_socket_shutdown( fnet_socket_t s, fnet_sd_flags_t how );

/***************************************************************************/ 
fnet_return_t fnet_socket_close( fnet_socket_t s );

/***************************************************************************/ 
fnet_return_t fnet_socket_setopt( fnet_socket_t s, fnet_protocol_t level, fnet_socket_options_t optname, const void *optval, fnet_size_t optvallen );

/***************************************************************************/ 
fnet_return_t fnet_socket_getopt( fnet_socket_t s, fnet_protocol_t level, fnet_socket_options_t optname, void *optval, fnet_size_t *optvallen );

/***************************************************************************/ 
fnet_return_t fnet_socket_getpeername( fnet_socket_t s, struct fnet_sockaddr *name, fnet_size_t *namelen );

/***************************************************************************/ 
fnet_return_t fnet_socket_getname( fnet_socket_t s, struct fnet_sockaddr *name, fnet_size_t *namelen );

/***************************************************************************/ 
fnet_bool_t fnet_socket_addr_are_equal(const struct fnet_sockaddr *addr1, const struct fnet_sockaddr *addr2);

/***************************************************************************/ 
fnet_bool_t fnet_socket_addr_is_unspecified(const struct fnet_sockaddr *addr);

/***************************************************************************/ 
fnet_bool_t fnet_socket_addr_is_multicast(const struct fnet_sockaddr *addr);

/***************************************************************************/ 
fnet_size_t fnet_socket_poll(fnet_socket_poll_t *socket_poll, fnet_size_t socket_poll_size);

#if FNET_CFG_SOCKET_CALLBACK_ON_RX || defined(__DOXYGEN__)
/***************************************************************************/ 
void fnet_socket_set_callback_on_rx( void(*callback)(void));
#endif

/*  BSD Socket API names */
#if FNET_CFG_SOCKET_BSD_NAMES
#define socket              fnet_socket
#define bind                fnet_socket_bind
#define listen              fnet_socket_listen
#define accept              fnet_socket_accept
#define connect             fnet_socket_connect
#define recv                fnet_socket_recv
#define recvfrom            fnet_socket_recvfrom
#define send                fnet_socket_send
#define sendto              fnet_socket_sendto
#define shutdown            fnet_socket_shutdown
#define closesocket         fnet_socket_close
#define setsockopt          fnet_socket_setopt
#define getsockopt          fnet_socket_getopt
#define getpeername         fnet_socket_getpeername
#define getsockname         fnet_socket_getname
#endif

#if defined(__cplusplus)
}
#endif

#endif /* _FNET_SOCKET_H_ */