socket.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright The Zephyr Project Contributors
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_POSIX_SYS_SOCKET_H_
#define ZEPHYR_INCLUDE_POSIX_SYS_SOCKET_H_
 
#include <stddef.h>
#include <sys/types.h>
 
#include <zephyr/net/net_ip.h>
#include <zephyr/net/socket.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if !(defined(_SOCKLEN_T_DECLARED) || defined(__socklen_t_defined)) || defined(__DOXYGEN__)
typedef net_socklen_t socklen_t;
#define _SOCKLEN_T_DECLARED
#define __socklen_t_defined
#endif
 
#if !(defined(_SA_FAMILY_T_DECLARED) || defined(__sa_family_t_defined)) || defined(__DOXYGEN__)
typedef net_sa_family_t sa_family_t;
#define _SA_FAMILY_T_DECLARED
#define __sa_family_t_defined
#endif
 
#if !(defined(_SOCKADDR_DECLARED) || defined(__sockaddr_defined)) || defined(__DOXYGEN__)
struct sockaddr {
    sa_family_t sa_family; 
    char sa_data[14];        
};
#define _SOCKADDR_DECLARED
#define __sockaddr_defined
#endif
 
#if !(defined(_SOCKADDR_STORAGE_DECLARED) || defined(__sockaddr_storage_defined)) || defined(__DOXYGEN__)
struct sockaddr_storage {
    sa_family_t ss_family; 
    char __ss_padding[128 - sizeof(sa_family_t)];
};
#define _SOCKADDR_STORAGE_DECLARED
#define __sockaddr_storage_defined
#endif
 
/* slightly out of order w.r.t. the specification */
#if !defined(_IOVEC_DECLARED) && !defined(__iovec_defined)
struct iovec {
    void  *iov_base;
    size_t iov_len;
};
#define _IOVEC_DECLARED
#define __iovec_defined
#endif
 
#if !(defined(_MSGHDR_DECLARED) || defined(__msghdr_defined)) || defined(__DOXYGEN__)
struct msghdr {
    void         *msg_name;       
    socklen_t     msg_namelen;    
    struct iovec *msg_iov;        
    size_t        msg_iovlen;     
    void         *msg_control;    
    size_t        msg_controllen; 
    int           msg_flags;      
};
#define _MSGHDR_DECLARED
#define __msghdr_defined
#endif
 
#if !(defined(_CMSGHDR_DECLARED) || defined(__cmsghdr_defined)) || defined(__DOXYGEN__)
struct cmsghdr {
    socklen_t cmsg_len;   
    int       cmsg_level; 
    int       cmsg_type;  
};
#define _CMSGHDR_DECLARED
#define __cmsghdr_defined
#endif
 
#define SCM_RIGHTS 1
 
 
#define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + ROUND_UP(sizeof(struct cmsghdr), sizeof(size_t)))
 
#define CMSG_NXTHDR(mhdr, cmsg)                                                        \
    (((cmsg) == NULL) ? CMSG_FIRSTHDR(mhdr) :                                        \
     (((unsigned char *)(cmsg) + ROUND_UP((cmsg)->cmsg_len, sizeof(size_t)) +                     \
       ROUND_UP(sizeof(struct cmsghdr), sizeof(size_t)) >                                         \
       (unsigned char *)((mhdr)->msg_control) + (mhdr)->msg_controllen) ?            \
      NULL :                                                                         \
      (struct cmsghdr *)((unsigned char *)(cmsg) + ROUND_UP((cmsg)->cmsg_len, sizeof(size_t)))))
 
#define CMSG_FIRSTHDR(mhdr)                                                            \
    (((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ?                           \
      (struct cmsghdr *)((mhdr)->msg_control) : NULL))
 
#if !(defined(_LINGER_DECLARED) || defined(__linger_defined)) || defined(__DOXYGEN__)
struct linger {
    int l_onoff;  
    int l_linger; 
};
#define _LINGER_DECLARED
#define __linger_defined
#endif
 
#define SOCK_DGRAM NET_SOCK_DGRAM
#define SOCK_RAW NET_SOCK_RAW
#define SOCK_SEQPACKET 5
#define SOCK_STREAM NET_SOCK_STREAM
 
#define SOL_SOCKET ZSOCK_SOL_SOCKET
 
#define SO_ACCEPTCONN ZSOCK_SO_ACCEPTCONN
#define SO_BROADCAST ZSOCK_SO_BROADCAST
#define SO_DEBUG ZSOCK_SO_DEBUG
#define SO_DONTROUTE ZSOCK_SO_DONTROUTE
#define SO_ERROR ZSOCK_SO_ERROR
#define SO_KEEPALIVE ZSOCK_SO_KEEPALIVE
#define SO_LINGER ZSOCK_SO_LINGER
#define SO_OOBINLINE ZSOCK_SO_OOBINLINE
#define SO_RCVBUF ZSOCK_SO_RCVBUF
#define SO_RCVLOWAT ZSOCK_SO_RCVLOWAT
#define SO_RCVTIMEO ZSOCK_SO_RCVTIMEO
#define SO_REUSEADDR ZSOCK_SO_REUSEADDR
#define SO_SNDBUF ZSOCK_SO_SNDBUF
#define SO_SNDLOWAT ZSOCK_SO_SNDLOWAT
#define SO_SNDTIMEO ZSOCK_SO_SNDTIMEO
#define SO_TYPE ZSOCK_SO_TYPE
 
#define SOMAXCONN ZSOCK_SOMAXCONN
 
#define MSG_CTRUNC ZSOCK_MSG_CTRUNC
#define MSG_DONTROUTE 0x04
#define MSG_EOR 0x80
#define MSG_OOB 0x01
#define MSG_NOSIGNAL 0x4000
#define MSG_PEEK ZSOCK_MSG_PEEK
#define MSG_TRUNC ZSOCK_MSG_TRUNC
#define MSG_WAITALL ZSOCK_MSG_WAITALL
 
#define AF_UNSPEC NET_AF_UNSPEC
#define AF_INET NET_AF_INET
#define AF_INET6 NET_AF_INET6
#define AF_UNIX NET_AF_UNIX
 
#define SHUT_RD ZSOCK_SHUT_RD
#define SHUT_WR ZSOCK_SHUT_WR
#define SHUT_RDWR ZSOCK_SHUT_RDWR
 
int accept(int sock, struct sockaddr *addr, socklen_t *addrlen);
 
int bind(int sock, const struct sockaddr *addr, socklen_t addrlen);
 
int connect(int sock, const struct sockaddr *addr, socklen_t addrlen);
 
int getpeername(int sock, struct sockaddr *addr, socklen_t *addrlen);
 
int getsockname(int sock, struct sockaddr *addr, socklen_t *addrlen);
 
int getsockopt(int sock, int level, int optname, void *optval, socklen_t *optlen);
 
int listen(int sock, int backlog);
 
ssize_t recv(int sock, void *buf, size_t max_len, int flags);
 
ssize_t recvfrom(int sock, void *buf, size_t max_len, int flags, struct sockaddr *src_addr,
         socklen_t *addrlen);
 
ssize_t recvmsg(int sock, struct msghdr *msg, int flags);
 
ssize_t send(int sock, const void *buf, size_t len, int flags);
 
ssize_t sendmsg(int sock, const struct msghdr *message, int flags);
 
ssize_t sendto(int sock, const void *buf, size_t len, int flags, const struct sockaddr *dest_addr,
           socklen_t addrlen);
 
int setsockopt(int sock, int level, int optname, const void *optval, socklen_t optlen);
 
int shutdown(int sock, int how);
 
int sockatmark(int s);
 
int socket(int family, int type, int proto);
 
int socketpair(int family, int type, int proto, int sv[2]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_POSIX_SYS_SOCKET_H_ */