epoc32/include/stdapis/netdb.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 /* NETDB.H
     2  * © Portions copyright (c) 2007 Symbian Software Ltd. All rights reserved.
     3  * Copyright (c) 1980, 1983, 1988, 1993
     4  *	The Regents of the University of California.  All rights reserved.
     5  *
     6  * Redistribution and use in source and binary forms, with or without
     7  * modification, are permitted provided that the following conditions
     8  * are met:
     9  * 1. Redistributions of source code must retain the above copyright
    10  *    notice, this list of conditions and the following disclaimer.
    11  * 2. Redistributions in binary form must reproduce the above copyright
    12  *    notice, this list of conditions and the following disclaimer in the
    13  *    documentation and/or other materials provided with the distribution.
    14  * 4. Neither the name of the University nor the names of its contributors
    15  *    may be used to endorse or promote products derived from this software
    16  *    without specific prior written permission.
    17  *
    18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    28  * SUCH DAMAGE.
    29  *
    30  * -
    31  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
    32  *
    33  * Permission to use, copy, modify, and distribute this software for any
    34  * purpose with or without fee is hereby granted, provided that the above
    35  * copyright notice and this permission notice appear in all copies, and that
    36  * the name of Digital Equipment Corporation not be used in advertising or
    37  * publicity pertaining to distribution of the document or software without
    38  * specific, written prior permission.
    39  *
    40  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
    41  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
    42  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
    43  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
    44  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
    45  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
    46  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
    47  * SOFTWARE.
    48  * -
    49  * --Copyright--
    50  */
    51 
    52 /*
    53  *      @(#)netdb.h	8.1 (Berkeley) 6/2/93
    54  *      From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $
    55  * $FreeBSD: src/include/netdb.h,v 1.38.2.1 2005/07/22 20:17:30 ume Exp $
    56  */
    57 
    58 #ifndef _NETDB_H_
    59 #define _NETDB_H_
    60 
    61 #ifdef __SYMBIAN32__
    62 #ifdef __cplusplus
    63 extern "C" {
    64 #endif
    65 #include <_ansi.h>
    66 
    67 #include <sys/cdefs.h>
    68 #endif
    69 #include <sys/_types.h>
    70 #include <sys/cdefs.h>
    71 #ifdef __SYMBIAN32__
    72 #include <arpa/inet.h>
    73 #include <sys/errno.h>
    74 #endif
    75 
    76 #ifndef _SIZE_T_DECLARED
    77 typedef	__size_t	size_t;
    78 #define	_SIZE_T_DECLARED
    79 #endif
    80 
    81 #ifndef _SOCKLEN_T_DECLARED
    82 typedef	__socklen_t	socklen_t;
    83 #define	_SOCKLEN_T_DECLARED
    84 #endif
    85 
    86 #ifndef _UINT32_T_DECLARED
    87 typedef	__uint32_t	uint32_t;
    88 #define	_UINT32_T_DECLARED
    89 #endif
    90 
    91 #ifndef _PATH_HEQUIV
    92 # define	_PATH_HEQUIV	"/etc/hosts.equiv"
    93 #endif
    94 #ifndef __SYMBIAN32__
    95 #define	_PATH_HOSTS	"/etc/hosts"
    96 #define	_PATH_NETWORKS	"/etc/networks"
    97 #define	_PATH_PROTOCOLS	"/etc/protocols"
    98 #define	_PATH_SERVICES	"/etc/services"
    99 #define	h_errno (*__h_error())
   100 #else
   101 #define	_PATH_SERVICES	"\\resource\\services"
   102 #define	_PATH_SERVICES_TARGET	"z:\\resource\\services"
   103 #define h_errno	errno
   104 #endif
   105 
   106 
   107 /*
   108  * Structures returned by network data base library.  All addresses are
   109  * supplied in host order, and returned in network order (suitable for
   110  * use in system calls).
   111  */
   112 struct hostent {
   113 	char	*h_name;	/* official name of host */
   114 	char	**h_aliases;	/* alias list */
   115 	int	h_addrtype;	/* host address type */
   116 	int	h_length;	/* length of address */
   117 	char	**h_addr_list;	/* list of addresses from name server */
   118 #define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
   119 };
   120 
   121 struct netent {
   122 	char		*n_name;	/* official name of net */
   123 	char		**n_aliases;	/* alias list */
   124 	int		n_addrtype;	/* net address type */
   125 	#ifdef __SYMBIAN32__
   126 	unsigned long n_net;
   127 	#else
   128 	uint32_t	n_net;		/* network # */
   129         #endif
   130 };
   131 
   132 struct servent {
   133 	char	*s_name;	/* official service name */
   134 	char	**s_aliases;	/* alias list */
   135 	int	s_port;		/* port # */
   136 	char	*s_proto;	/* protocol to use */
   137 };
   138 
   139 struct protoent {
   140 	char	*p_name;	/* official protocol name */
   141 	char	**p_aliases;	/* alias list */
   142 	int	p_proto;	/* protocol # */
   143 };
   144 
   145 struct addrinfo {
   146 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
   147 	int	ai_family;	/* PF_xxx */
   148 	int	ai_socktype;	/* SOCK_xxx */
   149 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
   150 	socklen_t ai_addrlen;	/* length of ai_addr */
   151 	char	*ai_canonname;	/* canonical name for hostname */
   152 	struct	sockaddr *ai_addr;	/* binary address */
   153 	struct	addrinfo *ai_next;	/* next structure in linked list */
   154 };
   155 
   156 /*
   157  * Error return codes from gethostbyname() and gethostbyaddr()
   158  * (left in h_errno).
   159  */
   160 
   161 #define	NETDB_INTERNAL	-1	/* see errno */
   162 #define	NETDB_SUCCESS	0	/* no problem */
   163 #ifndef __SYMBIAN32__
   164 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
   165 #define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
   166 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
   167 #else
   168 #define	HOST_NOT_FOUND	ENOENT		/* Authoritative Answer Host not found */
   169 #define	TRY_AGAIN	ETIMEDOUT	/* Non-Authoritative Host not found, or SERVERFAIL */
   170 #define	NO_RECOVERY	ECOMM		/* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
   171 #endif
   172 #define	NO_DATA		4 /* Valid name, no data record of requested type */
   173 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
   174 
   175 /*
   176  * Error return codes from getaddrinfo()
   177  */
   178 #if 0
   179 /* obsoleted */
   180 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
   181 #endif
   182 #define	EAI_AGAIN	 2	/* temporary failure in name resolution */
   183 #define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
   184 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
   185 #define	EAI_FAMILY	 5	/* ai_family not supported */
   186 #define	EAI_MEMORY	 6	/* memory allocation failure */
   187 #if 0
   188 /* obsoleted */
   189 #define	EAI_NODATA	 7	/* no address associated with hostname */
   190 #endif
   191 #define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
   192 #define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
   193 #define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
   194 #define	EAI_SYSTEM	11	/* system error returned in errno */
   195 #define	EAI_BADHINTS	12
   196 #define	EAI_PROTOCOL	13
   197 #define	EAI_MAX		14
   198 
   199 /*
   200  * Flag values for getaddrinfo()
   201  */
   202 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
   203 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
   204 #define	AI_NUMERICHOST	0x00000004 /* prevent host name resolution */
   205 #define	AI_NUMERICSERV	0x00000008 /* prevent service name resolution */
   206 /* valid flags for addrinfo (not a standard def, apps should not use it) */
   207 #define AI_MASK \
   208     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
   209     AI_ADDRCONFIG)
   210 
   211 #define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
   212 #define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
   213 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
   214 #define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
   215 /* special recommended flags for getipnodebyname */
   216 #define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
   217 
   218 /*
   219  * Constants for getnameinfo()
   220  */
   221 #define	NI_MAXHOST	1025
   222 #define	NI_MAXSERV	32
   223 
   224 /*
   225  * Flag values for getnameinfo()
   226  */
   227 #define	NI_NOFQDN	0x00000001
   228 #define	NI_NUMERICHOST	0x00000002
   229 #define	NI_NAMEREQD	0x00000004
   230 #define	NI_NUMERICSERV	0x00000008
   231 #define	NI_DGRAM	0x00000010
   232 #if 0 /* obsolete */
   233 #define NI_WITHSCOPEID	0x00000020
   234 #endif
   235 
   236 /*
   237  * Scope delimit character
   238  */
   239 #define	SCOPE_DELIMITER	'%'
   240 
   241 __BEGIN_DECLS
   242 #ifndef __SYMBIAN32__
   243 void		endhostent(void);
   244 void		endnetent(void);
   245 void		endnetgrent(void);
   246 void		endprotoent(void);
   247 #endif//__SYMBIAN32__
   248 IMPORT_C void		endservent(void);
   249 #ifndef __SYMBIAN32__
   250 void		freehostent(struct hostent *);
   251 #endif//__SYMBIAN32__
   252 IMPORT_C struct hostent	*gethostbyaddr(const char *, int, int);
   253 IMPORT_C struct hostent	*gethostbyname(const char *);
   254 #ifndef __SYMBIAN32__
   255 struct hostent	*gethostbyname2(const char *, int);
   256 struct hostent	*gethostent(void);
   257 struct hostent	*getipnodebyaddr(const void *, size_t, int, int *);
   258 struct hostent	*getipnodebyname(const char *, int, int, int *);
   259 struct netent	*getnetbyaddr(uint32_t, int);
   260 struct netent	*getnetbyname(const char *);
   261 struct netent	*getnetent(void);
   262 int		getnetgrent(char **, char **, char **);
   263 #endif//__SYMBIAN32__
   264 IMPORT_C struct protoent	*getprotobyname(const char *);
   265 IMPORT_C struct protoent	*getprotobynumber(int);
   266 #ifndef __SYMBIAN32__
   267 struct protoent	*getprotoent(void);
   268 #endif//__SYMBIAN32__
   269 IMPORT_C struct servent	*getservbyname(const char *, const char *);
   270 IMPORT_C struct servent	*getservbyport(int, const char *);
   271 IMPORT_C struct servent	*getservent(void);
   272 #ifndef __SYMBIAN32__
   273 void		herror(const char *);
   274 __const char	*hstrerror(int);
   275 int		innetgr(const char *, const char *, const char *, const char *);
   276 void		sethostent(int);
   277 /* void		sethostfile(const char *); */
   278 void		setnetent(int);
   279 void		setprotoent(int);
   280 #endif//__SYMBIAN32__
   281 IMPORT_C int		getaddrinfo(const char *, const char *,
   282 			    const struct addrinfo *, struct addrinfo **);
   283 IMPORT_C int		getnameinfo(const struct sockaddr *, socklen_t, char *,
   284 			    size_t, char *, size_t, int);
   285 IMPORT_C void		freeaddrinfo(struct addrinfo *);
   286 IMPORT_C const char	*gai_strerror(int);
   287 void		setnetgrent(const char *);
   288 IMPORT_C void		setservent(int);
   289 #ifdef __SYMBIAN32__
   290 
   291 #ifdef __SYMBIAN_COMPILE_UNUSED__
   292 int *__h_errno_location(void);
   293 #endif
   294 
   295 #endif
   296 
   297 /*
   298  * PRIVATE functions specific to the FreeBSD implementation
   299  */
   300 
   301 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
   302 int	* __h_error(void);
   303 __END_DECLS
   304 #ifdef __SYMBIAN32__
   305 #ifdef __cplusplus
   306 }
   307 #endif
   308 #endif
   309 
   310 #endif /* !_NETDB_H_ */