m2mb_socket.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/* Global declarations ==========================================================================*/
#ifndef  M2M_M2MB_SOCKET_API_H
#define  M2M_M2MB_SOCKET_API_H

#include <stdint.h>
#include <string.h>
#include "m2mb_types.h"
/*-----------------------------------------------------------------------------------------------*/
#define M2MB_SOCKET_BSD_INVALID_SOCKET  (M2MB_SOCKET_BSD_SOCKET)(~0)     
#define M2MB_SOCKET_BSD_SOCK_STREAM    1                                
#define M2MB_SOCKET_BSD_SOCK_DGRAM     2                                
#define M2MB_SOCKET_BSD_SOCK_RAW       3                                
#define M2MB_SOCKET_BSD_AF_UNSPEC      0                                
#define M2MB_SOCKET_BSD_AF_INET        2                                
#define M2MB_SOCKET_BSD_AF_INET6       3                                
#define M2MB_SOCKET_BSD_AF_INET_DUAL46  4                       
#define M2MB_SOCKET_BSD_AF_PACKET       5                       
#define M2MB_SOCKET_BSD_PF_UNSPEC      0                                
#define M2MB_SOCKET_BSD_PF_INET        2                                
#define M2MB_SOCKET_BSD_IPPROTO_DFLT     0                      
#define M2MB_SOCKET_BSD_IPPROTO_TCP    6                                
#define M2MB_SOCKET_BSD_IPPROTO_UDP   17                                
#define M2MB_SOCKET_BSD_IPPROTO_ICMP   1                                
/* ======================================================================= */

#define M2MB_SOCKET_BSD_SOL_SOCKET       (-1)           
#define M2MB_SOCKET_BSD_SO_DEBUG         0x00001        
#define M2MB_SOCKET_BSD_SO_ACCEPTCONN    0x00002        
#define M2MB_SOCKET_BSD_SO_REUSEADDR     0x00004        
#define M2MB_SOCKET_BSD_SO_KEEPALIVE     0x00008        
#define M2MB_SOCKET_BSD_SO_DONTROUTE     0x00010        
#define M2MB_SOCKET_BSD_SO_BROADCAST     0x00020        
#define M2MB_SOCKET_BSD_SO_USELOOPBACK   0x00040        
#define M2MB_SOCKET_BSD_SO_LINGER        0x00080        
#define M2MB_SOCKET_BSD_SO_OOBINLINE     0x00100        
#define M2MB_SOCKET_BSD_SO_DONTLINGER   (INT32)(~M2MB_SOCKET_BSD_SO_LINGER) /* Dont Linger,    Not supported */
#define M2MB_SOCKET_BSD_SO_TCPSACK       0x00200        
#define M2MB_SOCKET_BSD_SO_WINSCALE      0x00400        
#define M2MB_SOCKET_BSD_SO_TIMESTAMP     0x00800        
#define M2MB_SOCKET_BSD_SO_BIGCWND       0x01000        
#define M2MB_SOCKET_BSD_SO_HDRINCL       0x02000        
#define M2MB_SOCKET_BSD_SO_NOSLOWSTART   0x04000        
#define M2MB_SOCKET_BSD_SO_FULLMSS       0x08000        
#define M2MB_SOCKET_BSD_SO_SNDBUF        0x1001         
#define M2MB_SOCKET_BSD_SO_RCVBUF        0x1002         
#define M2MB_SOCKET_BSD_SO_SNDLOWAT      0x1003         
#define M2MB_SOCKET_BSD_SO_RCVLOWAT      0x1004         
#define M2MB_SOCKET_BSD_SO_SNDTIMEO      0x1005         
#define M2MB_SOCKET_BSD_SO_RCVTIMEO      0x1006         
#define M2MB_SOCKET_BSD_SO_ERROR         0x1007         
#define M2MB_SOCKET_BSD_SO_TYPE          0x1008         
#define M2MB_SOCKET_BSD_SO_HOPCNT        0x1009         
#define M2MB_SOCKET_BSD_SO_MAXMSG        0x1010         
#define M2MB_SOCKET_BSD_SO_RXDATA        0x1011         
#define M2MB_SOCKET_BSD_SO_TXDATA        0x1012         
#define M2MB_SOCKET_BSD_SO_MYADDR        0x1013         
#define M2MB_SOCKET_BSD_SO_NBIO                  0x1014         
#define M2MB_SOCKET_BSD_SO_BIO           0x1015         
#define M2MB_SOCKET_BSD_SO_NONBLOCK      0x1016         
#define M2MB_SOCKET_BSD_SO_CALLBACK      0x1017         
#define M2MB_SOCKET_BSD_SO_UDPCALLBACK   0x1019         
#define M2MB_SOCKET_BSD_IPPROTO_IP          0                   
#define M2MB_SOCKET_BSD_IP_HDRINCL          2                   
#define M2MB_SOCKET_BSD_IP_ADD_MEMBERSHIP   12                  
#define M2MB_SOCKET_BSD_IP_DROP_MEMBERSHIP  13                  
#define M2MB_SOCKET_BSD_IPV6_MULTICAST_IF   80                  
#define M2MB_SOCKET_BSD_IPV6_MULTICAST_HOPS 81                  
#define M2MB_SOCKET_BSD_IPV6_MULTICAST_LOOP 82                  
#define M2MB_SOCKET_BSD_IPV6_JOIN_GROUP     83                  
#define M2MB_SOCKET_BSD_IPV6_LEAVE_GROUP    84                  
#define M2MB_SOCKET_BSD_IP_OPTIONS          1                   
#define M2MB_SOCKET_BSD_IP_TOS              3                   
#define M2MB_SOCKET_BSD_IP_TTL_OPT          4                   
#define M2MB_SOCKET_BSD_IPV6_SCOPEID        14                  
#define M2MB_SOCKET_BSD_IPV6_UNICAST_HOPS   15                  
#define M2MB_SOCKET_BSD_IPV6_TCLASS         16                  
#define M2MB_SOCKET_BSD_TCP_NODELAY      0x01           
#define M2MB_SOCKET_BSD_TCP_KEEPALIVE    0x03           
/* ======================================================================= */

#define M2MB_SOCKET_BSD_INADDR_ANY           (UINT32) 0x00000000        
#define M2MB_SOCKET_BSD_INADDR_LOOPBACK          (UINT32) 0x7f000001    
#define M2MB_SOCKET_BSD_INADDR_BROADCAST     (UINT32) 0xffffffff        
/* ======================================================================= */

#define M2MB_SOCKET_BSD_SHUT_RD    0x00    
#define M2MB_SOCKET_BSD_SHUT_WR    0x01    
#define M2MB_SOCKET_BSD_SHUT_RDWR  0x02    
/* ======================================================================= */

#define M2MB_SOCKET_BSD_FIONREAD        0       
#define M2MB_SOCKET_BSD_FIONBIO         1       
/* ======================================================================= */

#define M2MB_SOCKET_BSD_SOCKET_ERROR        (-1)
#define M2MB_SOCKET_BSD_SOCKNOERROR           0
#define M2MB_SOCKET_BSD_ENOBUFS        1    
#define M2MB_SOCKET_BSD_ETIMEDOUT      2    
#define M2MB_SOCKET_BSD_EISCONN        3    
#define M2MB_SOCKET_BSD_EOPNOTSUPP     4    
#define M2MB_SOCKET_BSD_ECONNABORTED   5    
#define M2MB_SOCKET_BSD_EWOULDBLOCK    6        
#define M2MB_SOCKET_BSD_ECONNREFUSED   7    
#define M2MB_SOCKET_BSD_ECONNRESET     8    
#define M2MB_SOCKET_BSD_ENOTCONN       9    
#define M2MB_SOCKET_BSD_EBADF          9    
#define M2MB_SOCKET_BSD_EALREADY       10   
#define M2MB_SOCKET_BSD_EINVAL         11   
#define M2MB_SOCKET_BSD_EMSGSIZE       12   
#define M2MB_SOCKET_BSD_EPIPE          13   
#define M2MB_SOCKET_BSD_EDESTADDRREQ   14   
#define M2MB_SOCKET_BSD_ESHUTDOWN      15   
#define M2MB_SOCKET_BSD_ENOPROTOOPT    16   
#define M2MB_SOCKET_BSD_EHAVEOOB       17   
#define M2MB_SOCKET_BSD_ENOMEM         18   
#define M2MB_SOCKET_BSD_EADDRNOTAVAIL  19   
#define M2MB_SOCKET_BSD_EADDRINUSE     20   
#define M2MB_SOCKET_BSD_EAFNOSUPPORT   21   
#define M2MB_SOCKET_BSD_EINPROGRESS    22   
#define M2MB_SOCKET_BSD_ELOWER         23   
#define M2MB_SOCKET_BSD_ENOTSOCK       24   
#define M2MB_SOCKET_BSD_EIEIO          27   
#define M2MB_SOCKET_BSD_ETOOMANYREFS   28   
#define M2MB_SOCKET_BSD_EFAULT         29   
#define M2MB_SOCKET_BSD_ENETUNREACH    30   
/* ======================================================================= */

#define M2MB_SOCKET_HOST_NOT_FOUND  210
#define M2MB_SOCKET_NO_DATA         211
#define M2MB_SOCKET_NO_RECOVERY     212
#define M2MB_SOCKET_TRY_AGAIN       213
#define M2MB_SOCKET_ERANGE       214


#define M2MB_SOCKET_MSG_OOB             0x1      
#define M2MB_SOCKET_MSG_PEEK            0x2      
#define M2MB_SOCKET_MSG_DONTROUTE       0x4      
#define M2MB_SOCKET_MSG_DONTWAIT        0x20     
#define M2MB_SOCKET_MSG_ZEROCOPYSEND    0x1000   
#define M2MB_SOCKET_BSD_FD_SETSIZE      32

#define M2MB_SOCKET_MAX_SUPPORTED      16

#define MAKEIP(a,b,c,d) ((ULONG)d<<24 | (ULONG)c << 16 | (ULONG)b << 8 | (ULONG)a )

/* Global typedefs ==============================================================================*/
/* Socket identifier */
typedef iHANDLE M2MB_SOCKET_BSD_SOCKET;

typedef struct M2MB_SOCKET_BSD_LINGER
{
  INT32     l_onoff;                    
  INT32     l_linger;                   
}M2MB_SOCKET_BSD_LINGER_T;

typedef struct M2MB_SOCKET_BSD_SOCKADDR
{
  UINT8   _internal_sa_len;            
  UINT8   sa_family;
  CHAR    sa_data[14];
}M2MB_SOCKET_BSD_SOCKADDR_T;

/* ======================================================================= */

/* Structure for storing IPV4 address. */
typedef struct M2MB_SOCKET_BSD_IN_ADDR
{
  UINT32 s_addr;              
}M2MB_SOCKET_BSD_IN_ADDR_T;
typedef struct M2MB_SOCKET_BSD_IN6_ADDR
{
  UINT32 s_addr[4];
}M2MB_SOCKET_BSD_IN6_ADDR_T;
typedef struct M2MB_SOCKET_BSD_IPV6_ADDR
{
        union
        {
        UINT8   addr8[16];
        UINT16  addr16[8];
        UINT32  addr32[4];
        }v6_v;
#define addr8_s     v6_v.addr8
#define addr16_s    v6_v.addr16
#define addr32_s    v6_v.addr32
}M2MB_SOCKET_BSD_IPV6_ADDR_T;

typedef struct M2MB_SOCKET_BSD_SOCKADDR_IN
{
  UINT8         _internal_sin_len;              
  UINT8         sin_family;                     
  UINT16          sin_port;                     
  M2MB_SOCKET_BSD_IN_ADDR_T  sin_addr;          
  CHAR          sin_zero[8];                    
}M2MB_SOCKET_BSD_SOCKADDR_IN_T;


typedef struct M2MB_SOCKET_BSD_SOCKADDR_IN6
{
  UINT8   _internal_sin6_len;                           
  UINT8   sin6_family;                                  
  UINT16  sin6_port;                                    
  UINT32  sin6_flowinfo;
  struct M2MB_SOCKET_BSD_IPV6_ADDR  sin6_addr;  
  UINT32  sin6_scope_id;
}M2MB_SOCKET_BSD_SOCKADDR_IN6_T;

typedef struct M2MB_SOCKET_BSD_HOSTENT
{
  CHAR  *h_name;       
  CHAR **h_aliases;    
  INT32  h_addrtype;   
  INT32  h_length;     
  CHAR **h_addr_list;  
}M2MB_SOCKET_BSD_HOSTENT_T;

typedef struct M2MB_SOCKET_BSD_TIMEVAL
{
  INT32 m_tv_sec;       
  INT32 m_tv_usec;      
}M2MB_SOCKET_BSD_TIMEVAL_T;

typedef struct M2MB_SOCKET_BSD_FD_SET
{
  INT32  fd_count;                                      
  UINT32 fd_array[M2MB_SOCKET_BSD_FD_SETSIZE];                  
} M2MB_SOCKET_BSD_FD_SET_T;
typedef struct M2MB_IP6_ADDR
{
        
        UINT8  s_addr[16];   
}M2MB_IP6_ADDR_T;
typedef unsigned long M2MB_IP4_ADDR_T;
typedef struct M2MB_IP_MREQ
{
   M2MB_IP4_ADDR_T imr_multiaddr;
   M2MB_IP4_ADDR_T imr_interface;
}M2MB_IP_MREQ_T;

typedef struct M2MB_IP46_ADDR
{
    UINT16 type;
    union
    {
        M2MB_IP4_ADDR_T   addr4;
        M2MB_IP6_ADDR_T        addr6;
    } a;
#define Addr4     a.addr4
#define Addr6     a.addr6
}M2MB_IP46_ADDR_T;

typedef INT32 (*M2MB_NET_TCP_ZEROCOPY_CB)(
        void *so,
        void *packet,
        INT32 errcode
        );

typedef INT32 (*M2MB_NET_UDP_ZEROCOPY_CB )(
        void *so,
        void *packet,
        INT32 errcode,
        void *from,
        INT32 family
        );
/* ======================================================================== */
/*-----------------------------------------------------------------------------------------------*/
#define m2mb_socket_bsd_htonl(l) (((((l) >> 24) & 0x000000ff)) | \
                                                ((((l) >>  8) & 0x0000ff00)) | \
                                                (((l) & 0x0000ff00) <<  8) | \
                                                (((l) & 0x000000ff) << 24))
/*-----------------------------------------------------------------------------------------------*/
#define m2mb_socket_bsd_ntohl(l) m2mb_socket_bsd_htonl(l)
/*-----------------------------------------------------------------------------------------------*/
#define m2mb_socket_bsd_htons(s)    ((((s) >> 8) & 0xff) | (((s) << 8) & 0xff00))
/*-----------------------------------------------------------------------------------------------*/
#define m2mb_socket_bsd_ntohs(s) m2mb_socket_bsd_htons(s)
/*-----------------------------------------------------------------------------------------------*/
inline VOID 
M2MB_IPv6_CHANGE_ENDIAN(UINT32 *a)
{
        a[0] = m2mb_socket_bsd_htonl(a[0]);
        a[1] = m2mb_socket_bsd_htonl(a[1]);
        a[2] = m2mb_socket_bsd_htonl(a[2]);
        a[3] = m2mb_socket_bsd_htonl(a[3]);
}


/* Global functions =============================================================================*/
/* ======================================================================= */

/* M2M BSD socket interface */

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/

M2MB_SOCKET_BSD_SOCKET m2mb_socket_bsd_socket( INT32 domain, INT32 type, INT32 protocol );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_bind( M2MB_SOCKET_BSD_SOCKET s, struct M2MB_SOCKET_BSD_SOCKADDR *name, INT32 namelen );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_connect( M2MB_SOCKET_BSD_SOCKET s, const struct M2MB_SOCKET_BSD_SOCKADDR *name, INT32 namelen );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_listen( M2MB_SOCKET_BSD_SOCKET s, INT32 backlog );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_SOCKET_BSD_SOCKET m2mb_socket_bsd_accept( M2MB_SOCKET_BSD_SOCKET s, 
        struct M2MB_SOCKET_BSD_SOCKADDR *name, INT32 *namelen );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_close( M2MB_SOCKET_BSD_SOCKET s );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_get_peer_name( M2MB_SOCKET_BSD_SOCKET s, struct M2MB_SOCKET_BSD_SOCKADDR *name, INT32 *namelen );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_get_sock_name( M2MB_SOCKET_BSD_SOCKET s, struct M2MB_SOCKET_BSD_SOCKADDR *name, INT32 *namelen );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_recv( M2MB_SOCKET_BSD_SOCKET s, void *buf, INT32 len, INT32 flags );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_recv_from( M2MB_SOCKET_BSD_SOCKET s, void *buf, INT32 len, INT32 flags,
                                 struct M2MB_SOCKET_BSD_SOCKADDR *from, INT32 *fromlen );


/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_send( M2MB_SOCKET_BSD_SOCKET s, const void *buf, INT32 len, INT32 flags );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_send_to( M2MB_SOCKET_BSD_SOCKET s, const void *buf, INT32 len, INT32 flags,
                               const struct M2MB_SOCKET_BSD_SOCKADDR *to, INT32 tolen );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_get_sock_opt( M2MB_SOCKET_BSD_SOCKET s, INT32 level, INT32 optname, void *optval, INT32 *optlen );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_set_sock_opt( M2MB_SOCKET_BSD_SOCKET s, INT32 level, INT32 optname, const void *optval, INT32 optlen );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/

INT32 m2mb_socket_bsd_ioctl( M2MB_SOCKET_BSD_SOCKET s, INT32 cmd, void *argp );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_select( INT32 nfds, M2MB_SOCKET_BSD_FD_SET_T *readfds, M2MB_SOCKET_BSD_FD_SET_T *writefds,
                              M2MB_SOCKET_BSD_FD_SET_T *exceptfds, const struct M2MB_SOCKET_BSD_TIMEVAL *timeout );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_fd_zero_func( M2MB_SOCKET_BSD_FD_SET_T *set );

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_fd_set_func( INT32 fd, M2MB_SOCKET_BSD_FD_SET_T *set );

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_fd_clr_func( INT32 fd, M2MB_SOCKET_BSD_FD_SET_T *set );

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_fd_isset_func( INT32 fd, M2MB_SOCKET_BSD_FD_SET_T *set );

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_errno( INT32 fd );

/*-----------------------------------------------------------------------------------------------*/
const CHAR *m2mb_socket_bsd_inet_ntop( INT32 af, const void *src, CHAR *dst, SIZE_T size );

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_inet_pton( INT32 af, const CHAR *src, void *dst );

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_bsd_get_host_by_name_2_r_cid( const CHAR *name, INT32 af,
    struct M2MB_SOCKET_BSD_HOSTENT *ret, CHAR *buf, SIZE_T buflen,
    struct M2MB_SOCKET_BSD_HOSTENT **result, INT32 *h_errnop, UINT8 cid );

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_set_cid( M2MB_SOCKET_BSD_SOCKET s, UINT8 cid );
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_TCP_Keepalive_Set(INT32 idle_Time, INT32 resp_Timeout);
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_socket_TCP_Keepalive_Get(INT32 *idle_Time, INT32 *resp_Timeout);

#endif  /* M2M_M2MB_SOCKET_API_H */