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