/**************************************************************************** * net/socket/socket.h * * Copyright (C) 2007-2009, 2011-2014, 2017, 2019 Gregory Nutt. All rights * reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ #ifndef _NET_SOCKET_SOCKET_H #define _NET_SOCKET_SOCKET_H /**************************************************************************** * Included Files ****************************************************************************/ #include #ifdef CONFIG_NET #include #include #include #include #include /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /* This macro converts a socket option value into a bit setting */ #define _SO_BIT(o) (1 << (o)) /* These define bit positions for each socket option (see sys/socket.h) */ #define _SO_ACCEPTCONN _SO_BIT(SO_ACCEPTCONN) #define _SO_BROADCAST _SO_BIT(SO_BROADCAST) #define _SO_DEBUG _SO_BIT(SO_DEBUG) #define _SO_DONTROUTE _SO_BIT(SO_DONTROUTE) #define _SO_ERROR _SO_BIT(SO_ERROR) #define _SO_KEEPALIVE _SO_BIT(SO_KEEPALIVE) #define _SO_LINGER _SO_BIT(SO_LINGER) #define _SO_OOBINLINE _SO_BIT(SO_OOBINLINE) #define _SO_RCVBUF _SO_BIT(SO_RCVBUF) #define _SO_RCVLOWAT _SO_BIT(SO_RCVLOWAT) #define _SO_RCVTIMEO _SO_BIT(SO_RCVTIMEO) #define _SO_REUSEADDR _SO_BIT(SO_REUSEADDR) #define _SO_SNDBUF _SO_BIT(SO_SNDBUF) #define _SO_SNDLOWAT _SO_BIT(SO_SNDLOWAT) #define _SO_SNDTIMEO _SO_BIT(SO_SNDTIMEO) #define _SO_TYPE _SO_BIT(SO_TYPE) /* This is the largest option value. REVISIT: belongs in sys/socket.h */ #define _SO_MAXOPT (15) /* Macros to set, test, clear options */ #define _SO_SETOPT(s,o) ((s) |= _SO_BIT(o)) #define _SO_CLROPT(s,o) ((s) &= ~_SO_BIT(o)) #define _SO_GETOPT(s,o) (((s) & _SO_BIT(o)) != 0) /* These are macros that can be used to determine if socket option code is * valid (in range) and supported by API. */ #define _SO_GETONLYSET (_SO_ACCEPTCONN|_SO_ERROR|_SO_TYPE) #define _SO_GETONLY(o) ((_SO_BIT(o) & _SO_GETONLYSET) != 0) #define _SO_GETVALID(o) (((unsigned int)(o)) <= _SO_MAXOPT) #define _SO_SETVALID(o) ((((unsigned int)(o)) <= _SO_MAXOPT) && !_SO_GETONLY(o)) /* Macros to convert timeout value */ #ifdef CONFIG_NET_SOCKOPTS # define _SO_TIMEOUT(t) ((t) ? (t) * MSEC_PER_DSEC : UINT_MAX) #else # define _SO_TIMEOUT(t) (UINT_MAX) #endif /* CONFIG_NET_SOCKOPTS */ /* Macro to set socket errors */ #ifdef CONFIG_NET_SOCKOPTS # define _SO_SETERRNO(s,e) \ do \ { \ if (s != NULL) \ { \ s->s_error = (int16_t)e; \ } \ set_errno(e); \ } \ while (0) #else # define _SO_SETERRNO(s,e) set_errno(e) #endif /* CONFIG_NET_SOCKOPTS */ /**************************************************************************** * Public Data ****************************************************************************/ #undef EXTERN #if defined(__cplusplus) #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /**************************************************************************** * Public Function Prototypes ****************************************************************************/ /**************************************************************************** * Name: sockfd_allocate * * Description: * Allocate a socket descriptor * * Input Parameters: * Lowest socket descriptor index to be used. * * Returned Value: * On success, a socket descriptor >= minsd is returned. A negated errno * value is returned on failure. * ****************************************************************************/ int sockfd_allocate(int minsd); /**************************************************************************** * Name: psock_release * * Description: * Free a socket. * * Input Parameters: * psock - A reference to the socket instance to be freed. * * Returned Value: * None * ****************************************************************************/ void psock_release(FAR struct socket *psock); /**************************************************************************** * Name: sockfd_release * * Description: * Free the socket by its socket descriptor. * * Input Parameters: * sockfd - Socket descriptor identifies the socket to be released. * * Returned Value: * None * ****************************************************************************/ void sockfd_release(int sockfd); /**************************************************************************** * Name: net_sockif * * Description: * Return the socket interface associated with this address family. * * Input Parameters: * family - Socket address family * type - Socket type * protocol - Socket protocol * * Returned Value: * On success, a non-NULL instance of struct sock_intf_s is returned. NULL * is returned only if the address family is not supported. * ****************************************************************************/ FAR const struct sock_intf_s * net_sockif(sa_family_t family, int type, int protocol); /**************************************************************************** * Name: net_timeo * * Description: * Check if a timeout has elapsed. This can be called from a socket poll * function to determine if a timeout has occurred. * * Input Parameters: * start_time Timeout start time in system clock ticks * timeout Timeout value in deciseconds. * * Returned Value: * 0 (FALSE) if not timeout; 1 (TRUE) if timeout * * Assumptions: * ****************************************************************************/ #ifdef CONFIG_NET_SOCKOPTS int net_timeo(clock_t start_time, socktimeo_t timeo); #endif #endif /* CONFIG_NET */ #endif /* _NET_SOCKET_SOCKET_H */