netdb.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Linaro Limited
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_POSIX_NETDB_H_
#define ZEPHYR_INCLUDE_POSIX_NETDB_H_
 
#include <stdint.h>
 
#include <zephyr/net/socket.h>
#include <zephyr/net/dns_resolve.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if !(defined(_HOSTENT_DECLARED) || defined(__hostent_defined)) || defined(__DOXYGEN__)
struct hostent {
    char *h_name;       
    char **h_aliases;   
    int h_addrtype;     
    int h_length;       
    char **h_addr_list; 
};
#define _HOSTENT_DECLARED
#define __hostent_defined
#endif
 
#if !(defined(_NETENT_DECLARED) || defined(__netent_defined)) || defined(__DOXYGEN__)
struct netent {
    char *n_name;     
    char **n_aliases; 
    int n_addrtype;   
    uint32_t n_net;   
};
#define _NETENT_DECLARED
#define __netent_defined
#endif
 
#if !(defined(_PROTOENT_DECLARED) || defined(__protoent_defined)) || defined(__DOXYGEN__)
struct protoent {
    char *p_name;     
    char **p_aliases; 
    int p_proto;      
};
#define _PROTOENT_DECLARED
#define __protoent_defined
#endif
 
#if !(defined(_SERVENT_DECLARED) || defined(__servent_defined)) || defined(__DOXYGEN__)
struct servent {
    char *s_name;     
    char **s_aliases; 
    int s_port;       
    char *s_proto;    
};
#define _SERVENT_DECLARED
#define __servent_defined
#endif
 
#define IPPORT_RESERVED 1024
 
/*
 * required by addrinfo and several functions but absent in the spec
 * https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/netdb.h.html
 */
#if !defined(_SOCKLEN_T_DECLARED) && !defined(__socklen_t_defined)
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)
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)
struct sockaddr {
    sa_family_t sa_family;
    char sa_data[14];
};
#define _SOCKADDR_DECLARED
#define __sockaddr_defined
#endif
 
#if !(defined(_ADDRINFO_DECLARED) || defined(__addrinfo_defined)) || defined(__DOXYGEN__)
struct addrinfo {
    struct addrinfo *ai_next;      
    int              ai_flags;     
    int              ai_family;    
    int              ai_socktype;  
    int              ai_protocol;  
    int              ai_eflags; /* for zephyr compatibility */
    socklen_t        ai_addrlen;   
    struct sockaddr *ai_addr;      
    char            *ai_canonname; 
    struct net_sockaddr_storage _ai_addr; /* for zephyr compatibility */
    char             _ai_canonname[DNS_MAX_NAME_SIZE + 1]; /* for zephyr compatibility */
};
#define _ADDRINFO_DECLARED
#define __addrinfo_defined
#endif
 
/* getaddrinfo() flags for @c addrinfo.ai_flags. */
#define AI_PASSIVE ZSOCK_AI_PASSIVE
#define AI_CANONNAME ZSOCK_AI_CANONNAME
#define AI_NUMERICHOST ZSOCK_AI_NUMERICHOST
#define AI_NUMERICSERV ZSOCK_AI_NUMERICSERV
#define AI_V4MAPPED ZSOCK_AI_V4MAPPED
#define AI_ALL ZSOCK_AI_ALL
#define AI_ADDRCONFIG ZSOCK_AI_ADDRCONFIG
 
/* getnameinfo() flags for the @p flags argument. */
#define NI_NOFQDN ZSOCK_NI_NOFQDN
#define NI_NUMERICHOST ZSOCK_NI_NUMERICHOST
#define NI_NAMEREQD ZSOCK_NI_NAMEREQD
#define NI_NUMERICSERV ZSOCK_NI_NUMERICSERV
#define NI_NUMERICSCOPE 32
#define NI_DGRAM ZSOCK_NI_DGRAM
 
/* Error values for @ref getaddrinfo and @ref getnameinfo. */
#define EAI_AGAIN    DNS_EAI_AGAIN
#define EAI_BADFLAGS DNS_EAI_BADFLAGS
#define EAI_FAIL     DNS_EAI_FAIL
#define EAI_FAMILY   DNS_EAI_FAMILY
#define EAI_MEMORY   DNS_EAI_MEMORY
#define EAI_NONAME   DNS_EAI_NONAME
#define EAI_SERVICE  DNS_EAI_SERVICE
#define EAI_SOCKTYPE DNS_EAI_SOCKTYPE
#define EAI_SYSTEM   DNS_EAI_SYSTEM
#define EAI_OVERFLOW DNS_EAI_OVERFLOW
 
/* Non-POSIX extensions. */
#ifndef NI_MAXHOST
#define NI_MAXHOST 64
#endif
#ifndef NI_MAXSERV
#define NI_MAXSERV 32
#endif
#define EAI_NODATA   DNS_EAI_NODATA
 
void endhostent(void);
 
void endnetent(void);
 
void endprotoent(void);
 
void endservent(void);
 
void freeaddrinfo(struct addrinfo *ai);
 
const char *gai_strerror(int errcode);
 
int getaddrinfo(const char *host, const char *service, const struct addrinfo *hints,
        struct addrinfo **res);
 
struct hostent *gethostent(void);
 
int getnameinfo(const struct sockaddr *addr, socklen_t addrlen, char *host, socklen_t hostlen,
        char *serv, socklen_t servlen, int flags);
 
struct netent *getnetbyaddr(uint32_t net, int type);
 
struct netent *getnetbyname(const char *name);
 
struct netent *getnetent(void);
 
struct protoent *getprotobyname(const char *name);
 
struct protoent *getprotobynumber(int proto);
 
struct protoent *getprotoent(void);
 
struct servent *getservbyname(const char *name, const char *proto);
 
struct servent *getservbyport(int port, const char *proto);
 
struct servent *getservent(void);
 
void sethostent(int stayopen);
 
void setnetent(int stayopen);
 
void setprotoent(int stayopen);
 
void setservent(int stayopen);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* ZEPHYR_INCLUDE_POSIX_NETDB_H_ */