trustbridge/nss-cmake-static: nspr/pr/include/prio.h annotate

annotate nspr/pr/include/prio.h @ 3:150b72113545

Add DBM and legacydb support

author	Andre Heinecke <andre.heinecke@intevation.de>
date	Tue, 05 Aug 2014 18:32:02 +0200
parents	1e5118fa0cb1
children

rev	line source
0 1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1 /* -- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -- */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2 /* This Source Code Form is subject to the terms of the Mozilla Public
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3 * License, v. 2.0. If a copy of the MPL was not distributed with this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7 * File: prio.h
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	8 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	9 * Description: PR i/o related stuff, such as file system access, file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	10 * i/o, socket i/o, etc.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	11 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	12
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	13 #ifndef prio_h___
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	14 #define prio_h___
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	15
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	16 #include "prlong.h"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	17 #include "prtime.h"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	18 #include "prinrval.h"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	19 #include "prinet.h"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	20
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	21 PR_BEGIN_EXTERN_C
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	22
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	23 /* Typedefs */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	24 typedef struct PRDir PRDir;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	25 typedef struct PRDirEntry PRDirEntry;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	26 #ifdef MOZ_UNICODE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	27 typedef struct PRDirUTF16 PRDirUTF16;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	28 typedef struct PRDirEntryUTF16 PRDirEntryUTF16;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	29 #endif /* MOZ_UNICODE */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	30 typedef struct PRFileDesc PRFileDesc;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	31 typedef struct PRFileInfo PRFileInfo;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	32 typedef struct PRFileInfo64 PRFileInfo64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	33 typedef union PRNetAddr PRNetAddr;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	34 typedef struct PRIOMethods PRIOMethods;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	35 typedef struct PRPollDesc PRPollDesc;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	36 typedef struct PRFilePrivate PRFilePrivate;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	37 typedef struct PRSendFileData PRSendFileData;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	38
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	39 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	40 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	41 ** The file descriptor.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	42 ** This is the primary structure to represent any active open socket,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	43 ** whether it be a normal file or a network connection. Such objects
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	44 ** are stackable (or layerable). Each layer may have its own set of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	45 ** method pointers and context private to that layer. All each layer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	46 ** knows about its neighbors is how to get to their method table.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	47 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	48 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	49
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	50 typedef PRIntn PRDescIdentity; /* see: Layering file descriptors */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	51
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	52 struct PRFileDesc {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	53 const PRIOMethods methods; / the I/O methods table */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	54 PRFilePrivate secret; / layer dependent data */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	55 PRFileDesc lower, higher; /* pointers to adjacent layers */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	56 void (PR_CALLBACK dtor)(PRFileDesc fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	57 /* A destructor function for layer */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	58 PRDescIdentity identity; /* Identity of this particular layer */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	59 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	60
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	61 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	62 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	63 ** PRTransmitFileFlags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	64 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	65 ** Flags for PR_TransmitFile. Pass PR_TRANSMITFILE_CLOSE_SOCKET to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	66 ** PR_TransmitFile if the connection should be closed after the file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	67 ** is transmitted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	68 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	69 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	70 typedef enum PRTransmitFileFlags {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	71 PR_TRANSMITFILE_KEEP_OPEN = 0, /* socket is left open after file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	72 * is transmitted. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	73 PR_TRANSMITFILE_CLOSE_SOCKET = 1 /* socket is closed after file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	74 * is transmitted. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	75 } PRTransmitFileFlags;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	76
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	77 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	78 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	79 ** Macros for PRNetAddr
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	80 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	81 ** Address families: PR_AF_INET, PR_AF_INET6, PR_AF_LOCAL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	82 ** IP addresses: PR_INADDR_ANY, PR_INADDR_LOOPBACK, PR_INADDR_BROADCAST
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	83 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	84 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	85
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	86 #ifdef WIN32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	87
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	88 #define PR_AF_INET 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	89 #define PR_AF_LOCAL 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	90 #define PR_INADDR_ANY (unsigned long)0x00000000
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	91 #define PR_INADDR_LOOPBACK 0x7f000001
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	92 #define PR_INADDR_BROADCAST (unsigned long)0xffffffff
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	93
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	94 #else /* WIN32 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	95
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	96 #define PR_AF_INET AF_INET
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	97 #define PR_AF_LOCAL AF_UNIX
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	98 #define PR_INADDR_ANY INADDR_ANY
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	99 #define PR_INADDR_LOOPBACK INADDR_LOOPBACK
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	100 #define PR_INADDR_BROADCAST INADDR_BROADCAST
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	101
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	102 #endif /* WIN32 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	103
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	104 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	105 ** Define PR_AF_INET6 in prcpucfg.h with the same
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	106 ** value as AF_INET6 on platforms with IPv6 support.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	107 ** Otherwise define it here.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	108 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	109 #ifndef PR_AF_INET6
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	110 #define PR_AF_INET6 100
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	111 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	112
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	113 #define PR_AF_INET_SDP 101
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	114 #define PR_AF_INET6_SDP 102
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	115
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	116 #ifndef PR_AF_UNSPEC
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	117 #define PR_AF_UNSPEC 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	118 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	119
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	120 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	121 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	122 ** A network address
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	123 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	124 ** Only Internet Protocol (IPv4 and IPv6) addresses are supported.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	125 ** The address family must always represent IPv4 (AF_INET, probably == 2)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	126 ** or IPv6 (AF_INET6).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	127 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	128 *************************************************************************/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	129
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	130 struct PRIPv6Addr {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	131 union {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	132 PRUint8 _S6_u8[16];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	133 PRUint16 _S6_u16[8];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	134 PRUint32 _S6_u32[4];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	135 PRUint64 _S6_u64[2];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	136 } _S6_un;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	137 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	138 #define pr_s6_addr _S6_un._S6_u8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	139 #define pr_s6_addr16 _S6_un._S6_u16
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	140 #define pr_s6_addr32 _S6_un._S6_u32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	141 #define pr_s6_addr64 _S6_un._S6_u64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	142
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	143 typedef struct PRIPv6Addr PRIPv6Addr;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	144
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	145 union PRNetAddr {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	146 struct {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	147 PRUint16 family; /* address family (0x00ff maskable) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	148 #ifdef XP_BEOS
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	149 char data[10]; /* Be has a smaller structure */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	150 #else
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	151 char data[14]; /* raw address data */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	152 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	153 } raw;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	154 struct {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	155 PRUint16 family; /* address family (AF_INET) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	156 PRUint16 port; /* port number */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	157 PRUint32 ip; /* The actual 32 bits of address */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	158 #ifdef XP_BEOS
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	159 char pad[4]; /* Be has a smaller structure */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	160 #else
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	161 char pad[8];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	162 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	163 } inet;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	164 struct {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	165 PRUint16 family; /* address family (AF_INET6) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	166 PRUint16 port; /* port number */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	167 PRUint32 flowinfo; /* routing information */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	168 PRIPv6Addr ip; /* the actual 128 bits of address */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	169 PRUint32 scope_id; /* set of interfaces for a scope */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	170 } ipv6;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	171 #if defined(XP_UNIX) \|\| defined(XP_OS2)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	172 struct { /* Unix domain socket address */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	173 PRUint16 family; /* address family (AF_UNIX) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	174 #ifdef XP_OS2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	175 char path[108]; /* null-terminated pathname */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	176 /* bind fails if size is not 108. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	177 #else
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	178 char path[104]; /* null-terminated pathname */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	179 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	180 } local;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	181 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	182 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	183
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	184 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	185 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	186 ** PRSockOption
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	187 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	188 ** The file descriptors can have predefined options set after they file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	189 ** descriptor is created to change their behavior. Only the options in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	190 ** the following enumeration are supported.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	191 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	192 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	193 typedef enum PRSockOption
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	194 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	195 PR_SockOpt_Nonblocking, /* nonblocking io */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	196 PR_SockOpt_Linger, /* linger on close if data present */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	197 PR_SockOpt_Reuseaddr, /* allow local address reuse */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	198 PR_SockOpt_Keepalive, /* keep connections alive */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	199 PR_SockOpt_RecvBufferSize, /* send buffer size */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	200 PR_SockOpt_SendBufferSize, /* receive buffer size */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	201
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	202 PR_SockOpt_IpTimeToLive, /* time to live */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	203 PR_SockOpt_IpTypeOfService, /* type of service and precedence */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	204
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	205 PR_SockOpt_AddMember, /* add an IP group membership */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	206 PR_SockOpt_DropMember, /* drop an IP group membership */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	207 PR_SockOpt_McastInterface, /* multicast interface address */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	208 PR_SockOpt_McastTimeToLive, /* multicast timetolive */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	209 PR_SockOpt_McastLoopback, /* multicast loopback */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	210
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	211 PR_SockOpt_NoDelay, /* don't delay send to coalesce packets */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	212 PR_SockOpt_MaxSegment, /* maximum segment size */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	213 PR_SockOpt_Broadcast, /* enable broadcast */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	214 PR_SockOpt_Last
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	215 } PRSockOption;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	216
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	217 typedef struct PRLinger {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	218 PRBool polarity; /* Polarity of the option's setting */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	219 PRIntervalTime linger; /* Time to linger before closing */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	220 } PRLinger;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	221
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	222 typedef struct PRMcastRequest {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	223 PRNetAddr mcaddr; /* IP multicast address of group */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	224 PRNetAddr ifaddr; /* local IP address of interface */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	225 } PRMcastRequest;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	226
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	227 typedef struct PRSocketOptionData
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	228 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	229 PRSockOption option;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	230 union
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	231 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	232 PRUintn ip_ttl; /* IP time to live */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	233 PRUintn mcast_ttl; /* IP multicast time to live */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	234 PRUintn tos; /* IP type of service and precedence */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	235 PRBool non_blocking; /* Non-blocking (network) I/O */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	236 PRBool reuse_addr; /* Allow local address reuse */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	237 PRBool keep_alive; /* Keep connections alive */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	238 PRBool mcast_loopback; /* IP multicast loopback */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	239 PRBool no_delay; /* Don't delay send to coalesce packets */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	240 PRBool broadcast; /* Enable broadcast */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	241 PRSize max_segment; /* Maximum segment size */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	242 PRSize recv_buffer_size; /* Receive buffer size */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	243 PRSize send_buffer_size; /* Send buffer size */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	244 PRLinger linger; /* Time to linger on close if data present */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	245 PRMcastRequest add_member; /* add an IP group membership */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	246 PRMcastRequest drop_member; /* Drop an IP group membership */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	247 PRNetAddr mcast_if; /* multicast interface address */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	248 } value;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	249 } PRSocketOptionData;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	250
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	251 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	252 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	253 ** PRIOVec
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	254 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	255 ** The I/O vector is used by the write vector method to describe the areas
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	256 ** that are affected by the ouput operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	257 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	258 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	259 typedef struct PRIOVec {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	260 char *iov_base;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	261 int iov_len;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	262 } PRIOVec;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	263
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	264 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	265 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	266 ** Discover what type of socket is being described by the file descriptor.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	267 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	268 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	269 typedef enum PRDescType
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	270 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	271 PR_DESC_FILE = 1,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	272 PR_DESC_SOCKET_TCP = 2,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	273 PR_DESC_SOCKET_UDP = 3,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	274 PR_DESC_LAYERED = 4,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	275 PR_DESC_PIPE = 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	276 } PRDescType;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	277
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	278 typedef enum PRSeekWhence {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	279 PR_SEEK_SET = 0,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	280 PR_SEEK_CUR = 1,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	281 PR_SEEK_END = 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	282 } PRSeekWhence;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	283
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	284 NSPR_API(PRDescType) PR_GetDescType(PRFileDesc *file);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	285
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	286 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	287 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	288 ** PRIOMethods
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	289 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	290 ** The I/O methods table provides procedural access to the functions of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	291 ** the file descriptor. It is the responsibility of a layer implementor
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	292 ** to provide suitable functions at every entry point. If a layer provides
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	293 ** no functionality, it should call the next lower(higher) function of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	294 ** same name (e.g., return fd->lower->method->close(fd->lower));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	295 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	296 ** Not all functions are implemented for all types of files. In cases where
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	297 ** that is true, the function will return a error indication with an error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	298 ** code of PR_INVALID_METHOD_ERROR.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	299 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	300 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	301
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	302 typedef PRStatus (PR_CALLBACK PRCloseFN)(PRFileDesc fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	303 typedef PRInt32 (PR_CALLBACK PRReadFN)(PRFileDesc fd, void *buf, PRInt32 amount);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	304 typedef PRInt32 (PR_CALLBACK PRWriteFN)(PRFileDesc fd, const void *buf, PRInt32 amount);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	305 typedef PRInt32 (PR_CALLBACK PRAvailableFN)(PRFileDesc fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	306 typedef PRInt64 (PR_CALLBACK PRAvailable64FN)(PRFileDesc fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	307 typedef PRStatus (PR_CALLBACK PRFsyncFN)(PRFileDesc fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	308 typedef PROffset32 (PR_CALLBACK PRSeekFN)(PRFileDesc fd, PROffset32 offset, PRSeekWhence how);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	309 typedef PROffset64 (PR_CALLBACK PRSeek64FN)(PRFileDesc fd, PROffset64 offset, PRSeekWhence how);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	310 typedef PRStatus (PR_CALLBACK PRFileInfoFN)(PRFileDesc fd, PRFileInfo *info);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	311 typedef PRStatus (PR_CALLBACK PRFileInfo64FN)(PRFileDesc fd, PRFileInfo64 *info);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	312 typedef PRInt32 (PR_CALLBACK *PRWritevFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	313 PRFileDesc fd, const PRIOVec iov, PRInt32 iov_size,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	314 PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	315 typedef PRStatus (PR_CALLBACK *PRConnectFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	316 PRFileDesc fd, const PRNetAddr addr, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	317 typedef PRFileDesc* (PR_CALLBACK *PRAcceptFN) (
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	318 PRFileDesc fd, PRNetAddr addr, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	319 typedef PRStatus (PR_CALLBACK PRBindFN)(PRFileDesc fd, const PRNetAddr *addr);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	320 typedef PRStatus (PR_CALLBACK PRListenFN)(PRFileDesc fd, PRIntn backlog);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	321 typedef PRStatus (PR_CALLBACK PRShutdownFN)(PRFileDesc fd, PRIntn how);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	322 typedef PRInt32 (PR_CALLBACK *PRRecvFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	323 PRFileDesc fd, void buf, PRInt32 amount,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	324 PRIntn flags, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	325 typedef PRInt32 (PR_CALLBACK *PRSendFN) (
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	326 PRFileDesc fd, const void buf, PRInt32 amount,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	327 PRIntn flags, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	328 typedef PRInt32 (PR_CALLBACK *PRRecvfromFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	329 PRFileDesc fd, void buf, PRInt32 amount,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	330 PRIntn flags, PRNetAddr *addr, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	331 typedef PRInt32 (PR_CALLBACK *PRSendtoFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	332 PRFileDesc fd, const void buf, PRInt32 amount,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	333 PRIntn flags, const PRNetAddr *addr, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	334 typedef PRInt16 (PR_CALLBACK *PRPollFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	335 PRFileDesc fd, PRInt16 in_flags, PRInt16 out_flags);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	336 typedef PRInt32 (PR_CALLBACK *PRAcceptreadFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	337 PRFileDesc sd, PRFileDesc nd, PRNetAddr *raddr,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	338 void *buf, PRInt32 amount, PRIntervalTime t);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	339 typedef PRInt32 (PR_CALLBACK *PRTransmitfileFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	340 PRFileDesc sd, PRFileDesc fd, const void *headers,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	341 PRInt32 hlen, PRTransmitFileFlags flags, PRIntervalTime t);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	342 typedef PRStatus (PR_CALLBACK PRGetsocknameFN)(PRFileDesc fd, PRNetAddr *addr);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	343 typedef PRStatus (PR_CALLBACK PRGetpeernameFN)(PRFileDesc fd, PRNetAddr *addr);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	344 typedef PRStatus (PR_CALLBACK *PRGetsocketoptionFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	345 PRFileDesc fd, PRSocketOptionData data);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	346 typedef PRStatus (PR_CALLBACK *PRSetsocketoptionFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	347 PRFileDesc fd, const PRSocketOptionData data);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	348 typedef PRInt32 (PR_CALLBACK *PRSendfileFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	349 PRFileDesc networkSocket, PRSendFileData sendData,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	350 PRTransmitFileFlags flags, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	351 typedef PRStatus (PR_CALLBACK *PRConnectcontinueFN)(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	352 PRFileDesc *fd, PRInt16 out_flags);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	353 typedef PRIntn (PR_CALLBACK PRReservedFN)(PRFileDesc fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	354
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	355 struct PRIOMethods {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	356 PRDescType file_type; /* Type of file represented (tos) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	357 PRCloseFN close; /* close file and destroy descriptor */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	358 PRReadFN read; /* read up to specified bytes into buffer */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	359 PRWriteFN write; /* write specified bytes from buffer */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	360 PRAvailableFN available; /* determine number of bytes available */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	361 PRAvailable64FN available64; /* ditto, 64 bit */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	362 PRFsyncFN fsync; /* flush all buffers to permanent store */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	363 PRSeekFN seek; /* position the file to the desired place */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	364 PRSeek64FN seek64; /* ditto, 64 bit */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	365 PRFileInfoFN fileInfo; /* Get information about an open file */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	366 PRFileInfo64FN fileInfo64; /* ditto, 64 bit */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	367 PRWritevFN writev; /* Write segments as described by iovector */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	368 PRConnectFN connect; /* Connect to the specified (net) address */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	369 PRAcceptFN accept; /* Accept a connection for a (net) peer */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	370 PRBindFN bind; /* Associate a (net) address with the fd */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	371 PRListenFN listen; /* Prepare to listen for (net) connections */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	372 PRShutdownFN shutdown; /* Shutdown a (net) connection */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	373 PRRecvFN recv; /* Solicit up the the specified bytes */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	374 PRSendFN send; /* Send all the bytes specified */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	375 PRRecvfromFN recvfrom; /* Solicit (net) bytes and report source */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	376 PRSendtoFN sendto; /* Send bytes to (net) address specified */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	377 PRPollFN poll; /* Test the fd to see if it is ready */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	378 PRAcceptreadFN acceptread; /* Accept and read on a new (net) fd */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	379 PRTransmitfileFN transmitfile; /* Transmit at entire file */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	380 PRGetsocknameFN getsockname; /* Get (net) address associated with fd */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	381 PRGetpeernameFN getpeername; /* Get peer's (net) address */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	382 PRReservedFN reserved_fn_6; /* reserved for future use */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	383 PRReservedFN reserved_fn_5; /* reserved for future use */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	384 PRGetsocketoptionFN getsocketoption;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	385 /* Get current setting of specified option */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	386 PRSetsocketoptionFN setsocketoption;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	387 /* Set value of specified option */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	388 PRSendfileFN sendfile; /* Send a (partial) file with header/trailer*/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	389 PRConnectcontinueFN connectcontinue;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	390 /* Continue a nonblocking connect */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	391 PRReservedFN reserved_fn_3; /* reserved for future use */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	392 PRReservedFN reserved_fn_2; /* reserved for future use */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	393 PRReservedFN reserved_fn_1; /* reserved for future use */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	394 PRReservedFN reserved_fn_0; /* reserved for future use */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	395 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	396
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	397 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	398 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	399 * FUNCTION: PR_GetSpecialFD
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	400 * DESCRIPTION: Get the file descriptor that represents the standard input,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	401 * output, or error stream.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	402 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	403 * PRSpecialFD id
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	404 * A value indicating the type of stream desired:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	405 * PR_StandardInput: standard input
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	406 * PR_StandardOuput: standard output
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	407 * PR_StandardError: standard error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	408 * OUTPUTS: none
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	409 * RETURNS: PRFileDesc *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	410 * If the argument is valid, PR_GetSpecialFD returns a file descriptor
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	411 * that represents the corresponding standard I/O stream. Otherwise,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	412 * PR_GetSpecialFD returns NULL and sets error PR_INVALID_ARGUMENT_ERROR.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	413 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	414 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	415
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	416 typedef enum PRSpecialFD
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	417 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	418 PR_StandardInput, /* standard input */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	419 PR_StandardOutput, /* standard output */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	420 PR_StandardError /* standard error */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	421 } PRSpecialFD;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	422
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	423 NSPR_API(PRFileDesc*) PR_GetSpecialFD(PRSpecialFD id);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	424
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	425 #define PR_STDIN PR_GetSpecialFD(PR_StandardInput)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	426 #define PR_STDOUT PR_GetSpecialFD(PR_StandardOutput)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	427 #define PR_STDERR PR_GetSpecialFD(PR_StandardError)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	428
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	429 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	430 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	431 * Layering file descriptors
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	432 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	433 * File descriptors may be layered. Each layer has it's own identity.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	434 * Identities are allocated by the runtime and are to be associated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	435 * (by the layer implementor) with all layers that are of that type.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	436 * It is then possible to scan the chain of layers and find a layer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	437 * that one recongizes and therefore predict that it will implement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	438 * a desired protocol.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	439 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	440 * There are three well-known identities:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	441 * PR_INVALID_IO_LAYER => an invalid layer identity, for error return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	442 * PR_TOP_IO_LAYER => the identity of the top of the stack
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	443 * PR_NSPR_IO_LAYER => the identity used by NSPR proper
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	444 * PR_TOP_IO_LAYER may be used as a shorthand for identifying the topmost
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	445 * layer of an existing stack. Ie., the following two constructs are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	446 * equivalent.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	447 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	448 * rv = PR_PushIOLayer(stack, PR_TOP_IO_LAYER, my_layer);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	449 * rv = PR_PushIOLayer(stack, PR_GetLayersIdentity(stack), my_layer)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	450 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	451 * A string may be associated with the creation of the identity. It
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	452 * will be copied by the runtime. If queried the runtime will return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	453 * a reference to that copied string (not yet another copy). There
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	454 * is no facility for deleting an identity.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	455 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	456 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	457
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	458 #define PR_IO_LAYER_HEAD (PRDescIdentity)-3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	459 #define PR_INVALID_IO_LAYER (PRDescIdentity)-1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	460 #define PR_TOP_IO_LAYER (PRDescIdentity)-2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	461 #define PR_NSPR_IO_LAYER (PRDescIdentity)0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	462
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	463 NSPR_API(PRDescIdentity) PR_GetUniqueIdentity(const char *layer_name);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	464 NSPR_API(const char*) PR_GetNameForIdentity(PRDescIdentity ident);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	465 NSPR_API(PRDescIdentity) PR_GetLayersIdentity(PRFileDesc* fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	466 NSPR_API(PRFileDesc) PR_GetIdentitiesLayer(PRFileDesc fd_stack, PRDescIdentity id);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	467
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	468 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	469 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	470 * PR_GetDefaultIOMethods: Accessing the default methods table.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	471 * You may get a pointer to the default methods table by calling this function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	472 * You may then select any elements from that table with which to build your
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	473 * layer's methods table. You may NOT modify the table directly.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	474 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	475 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	476 NSPR_API(const PRIOMethods *) PR_GetDefaultIOMethods(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	477
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	478 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	479 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	480 * Creating a layer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	481 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	482 * A new layer may be allocated by calling PR_CreateIOLayerStub(). The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	483 * file descriptor returned will contain the pointer to the methods table
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	484 * provided. The runtime will not modify the table nor test its correctness.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	485 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	486 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	487 NSPR_API(PRFileDesc*) PR_CreateIOLayerStub(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	488 PRDescIdentity ident, const PRIOMethods *methods);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	489
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	490 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	491 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	492 * Creating a layer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	493 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	494 * A new stack may be created by calling PR_CreateIOLayer(). The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	495 * file descriptor returned will point to the top of the stack, which has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	496 * the layer 'fd' as the topmost layer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	497 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	498 * NOTE: This function creates a new style stack, which has a fixed, dummy
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	499 * header. The old style stack, created by a call to PR_PushIOLayer,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	500 * results in modifying contents of the top layer of the stack, when
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	501 * pushing and popping layers of the stack.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	502 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	503 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	504 NSPR_API(PRFileDesc) PR_CreateIOLayer(PRFileDesc fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	505
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	506 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	507 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	508 * Pushing a layer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	509 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	510 * A file descriptor (perhaps allocated using PR_CreateIOLayerStub()) may
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	511 * be pushed into an existing stack of file descriptors at any point the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	512 * caller deems appropriate. The new layer will be inserted into the stack
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	513 * just above the layer with the indicated identity.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	514 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	515 * Note: Even if the identity parameter indicates the top-most layer of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	516 * the stack, the value of the file descriptor describing the original
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	517 * stack will not change.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	518 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	519 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	520 NSPR_API(PRStatus) PR_PushIOLayer(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	521 PRFileDesc fd_stack, PRDescIdentity id, PRFileDesc layer);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	522
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	523 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	524 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	525 * Popping a layer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	526 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	527 * A layer may be popped from a stack by indicating the identity of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	528 * layer to be removed. If found, a pointer to the removed object will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	529 * be returned to the caller. The object then becomes the responsibility
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	530 * of the caller.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	531 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	532 * Note: Even if the identity indicates the top layer of the stack, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	533 * reference returned will not be the file descriptor for the stack and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	534 * that file descriptor will remain valid.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	535 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	536 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	537 NSPR_API(PRFileDesc) PR_PopIOLayer(PRFileDesc fd_stack, PRDescIdentity id);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	538
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	539 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	540 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	541 * FUNCTION: PR_Open
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	542 * DESCRIPTION: Open a file for reading, writing, or both.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	543 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	544 * const char *name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	545 * The path name of the file to be opened
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	546 * PRIntn flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	547 * The file status flags.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	548 * It is a bitwise OR of the following bit flags (only one of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	549 * the first three flags below may be used):
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	550 * PR_RDONLY Open for reading only.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	551 * PR_WRONLY Open for writing only.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	552 * PR_RDWR Open for reading and writing.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	553 * PR_CREATE_FILE If the file does not exist, the file is created
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	554 * If the file exists, this flag has no effect.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	555 * PR_SYNC If set, each write will wait for both the file data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	556 * and file status to be physically updated.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	557 * PR_APPEND The file pointer is set to the end of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	558 * the file prior to each write.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	559 * PR_TRUNCATE If the file exists, its length is truncated to 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	560 * PR_EXCL With PR_CREATE_FILE, if the file does not exist,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	561 * the file is created. If the file already
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	562 * exists, no action and NULL is returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	563 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	564 * PRIntn mode
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	565 * The access permission bits of the file mode, if the file is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	566 * created when PR_CREATE_FILE is on.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	567 * OUTPUTS: None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	568 * RETURNS: PRFileDesc *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	569 * If the file is successfully opened,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	570 * returns a pointer to the PRFileDesc
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	571 * created for the newly opened file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	572 * Returns a NULL pointer if the open
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	573 * failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	574 * SIDE EFFECTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	575 * RESTRICTIONS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	576 * MEMORY:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	577 * The return value, if not NULL, points to a dynamically allocated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	578 * PRFileDesc object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	579 * ALGORITHM:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	580 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	581 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	582
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	583 /* Open flags */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	584 #define PR_RDONLY 0x01
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	585 #define PR_WRONLY 0x02
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	586 #define PR_RDWR 0x04
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	587 #define PR_CREATE_FILE 0x08
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	588 #define PR_APPEND 0x10
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	589 #define PR_TRUNCATE 0x20
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	590 #define PR_SYNC 0x40
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	591 #define PR_EXCL 0x80
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	592
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	593 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	594 ** File modes ....
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	595 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	596 ** CAVEAT: 'mode' is currently only applicable on UNIX platforms.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	597 ** The 'mode' argument may be ignored by PR_Open on other platforms.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	598 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	599 ** 00400 Read by owner.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	600 ** 00200 Write by owner.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	601 ** 00100 Execute (search if a directory) by owner.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	602 ** 00040 Read by group.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	603 ** 00020 Write by group.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	604 ** 00010 Execute by group.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	605 ** 00004 Read by others.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	606 ** 00002 Write by others
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	607 ** 00001 Execute by others.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	608 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	609 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	610
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	611 NSPR_API(PRFileDesc) PR_Open(const char name, PRIntn flags, PRIntn mode);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	612
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	613 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	614 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	615 * FUNCTION: PR_OpenFile
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	616 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	617 * Open a file for reading, writing, or both.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	618 * PR_OpenFile has the same prototype as PR_Open but implements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	619 * the specified file mode where possible.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	620 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	621 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	622
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	623 /* File mode bits */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	624 #define PR_IRWXU 00700 /* read, write, execute/search by owner */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	625 #define PR_IRUSR 00400 /* read permission, owner */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	626 #define PR_IWUSR 00200 /* write permission, owner */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	627 #define PR_IXUSR 00100 /* execute/search permission, owner */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	628 #define PR_IRWXG 00070 /* read, write, execute/search by group */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	629 #define PR_IRGRP 00040 /* read permission, group */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	630 #define PR_IWGRP 00020 /* write permission, group */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	631 #define PR_IXGRP 00010 /* execute/search permission, group */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	632 #define PR_IRWXO 00007 /* read, write, execute/search by others */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	633 #define PR_IROTH 00004 /* read permission, others */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	634 #define PR_IWOTH 00002 /* write permission, others */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	635 #define PR_IXOTH 00001 /* execute/search permission, others */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	636
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	637 NSPR_API(PRFileDesc*) PR_OpenFile(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	638 const char *name, PRIntn flags, PRIntn mode);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	639
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	640 #ifdef MOZ_UNICODE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	641 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	642 * EXPERIMENTAL: This function may be removed in a future release.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	643 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	644 NSPR_API(PRFileDesc*) PR_OpenFileUTF16(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	645 const PRUnichar *name, PRIntn flags, PRIntn mode);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	646 #endif /* MOZ_UNICODE */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	647
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	648 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	649 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	650 * FUNCTION: PR_Close
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	651 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	652 * Close a file or socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	653 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	654 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	655 * a pointer to a PRFileDesc.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	656 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	657 * None.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	658 * RETURN:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	659 * PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	660 * SIDE EFFECTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	661 * RESTRICTIONS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	662 * None.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	663 * MEMORY:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	664 * The dynamic memory pointed to by the argument fd is freed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	665 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	666 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	667
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	668 NSPR_API(PRStatus) PR_Close(PRFileDesc *fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	669
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	670 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	671 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	672 * FUNCTION: PR_Read
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	673 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	674 * Read bytes from a file or socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	675 * The operation will block until either an end of stream indication is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	676 * encountered, some positive number of bytes are transferred, or there
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	677 * is an error. No more than 'amount' bytes will be transferred.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	678 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	679 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	680 * pointer to the PRFileDesc object for the file or socket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	681 * void *buf
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	682 * pointer to a buffer to hold the data read in.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	683 * PRInt32 amount
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	684 * the size of 'buf' (in bytes)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	685 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	686 * RETURN:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	687 * PRInt32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	688 * a positive number indicates the number of bytes actually read in.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	689 * 0 means end of file is reached or the network connection is closed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	690 * -1 indicates a failure. The reason for the failure is obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	691 * by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	692 * SIDE EFFECTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	693 * data is written into the buffer pointed to by 'buf'.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	694 * RESTRICTIONS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	695 * None.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	696 * MEMORY:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	697 * N/A
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	698 * ALGORITHM:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	699 * N/A
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	700 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	701 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	702
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	703 NSPR_API(PRInt32) PR_Read(PRFileDesc fd, void buf, PRInt32 amount);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	704
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	705 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	706 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	707 * FUNCTION: PR_Write
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	708 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	709 * Write a specified number of bytes to a file or socket. The thread
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	710 * invoking this function blocks until all the data is written.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	711 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	712 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	713 * pointer to a PRFileDesc object that refers to a file or socket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	714 * const void *buf
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	715 * pointer to the buffer holding the data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	716 * PRInt32 amount
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	717 * amount of data in bytes to be written from the buffer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	718 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	719 * None.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	720 * RETURN: PRInt32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	721 * A positive number indicates the number of bytes successfully written.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	722 * A -1 is an indication that the operation failed. The reason
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	723 * for the failure is obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	724 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	725 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	726
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	727 NSPR_API(PRInt32) PR_Write(PRFileDesc fd,const void buf,PRInt32 amount);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	728
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	729 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	730 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	731 * FUNCTION: PR_Writev
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	732 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	733 * Write data to a socket. The data is organized in a PRIOVec array. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	734 * operation will block until all the data is written or the operation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	735 * fails.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	736 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	737 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	738 * Pointer that points to a PRFileDesc object for a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	739 * const PRIOVec *iov
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	740 * An array of PRIOVec. PRIOVec is a struct with the following
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	741 * two fields:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	742 * char *iov_base;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	743 * int iov_len;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	744 * PRInt32 iov_size
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	745 * Number of elements in the iov array. The value of this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	746 * argument must not be greater than PR_MAX_IOVECTOR_SIZE.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	747 * If it is, the method will fail (PR_BUFFER_OVERFLOW_ERROR).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	748 * PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	749 * Time limit for completion of the entire write operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	750 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	751 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	752 * RETURN:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	753 * A positive number indicates the number of bytes successfully written.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	754 * A -1 is an indication that the operation failed. The reason
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	755 * for the failure is obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	756 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	757 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	758
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	759 #define PR_MAX_IOVECTOR_SIZE 16 /* 'iov_size' must be <= */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	760
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	761 NSPR_API(PRInt32) PR_Writev(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	762 PRFileDesc fd, const PRIOVec iov, PRInt32 iov_size,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	763 PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	764
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	765 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	766 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	767 * FUNCTION: PR_Delete
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	768 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	769 * Delete a file from the filesystem. The operation may fail if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	770 * file is open.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	771 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	772 * const char *name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	773 * Path name of the file to be deleted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	774 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	775 * None.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	776 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	777 * The function returns PR_SUCCESS if the file is successfully
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	778 * deleted, otherwise it returns PR_FAILURE.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	779 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	780 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	781
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	782 NSPR_API(PRStatus) PR_Delete(const char *name);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	783
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	784 /**************************************************************************/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	785
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	786 typedef enum PRFileType
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	787 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	788 PR_FILE_FILE = 1,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	789 PR_FILE_DIRECTORY = 2,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	790 PR_FILE_OTHER = 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	791 } PRFileType;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	792
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	793 struct PRFileInfo {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	794 PRFileType type; /* Type of file */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	795 PROffset32 size; /* Size, in bytes, of file's contents */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	796 PRTime creationTime; /* Creation time per definition of PRTime */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	797 PRTime modifyTime; /* Last modification time per definition of PRTime */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	798 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	799
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	800 struct PRFileInfo64 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	801 PRFileType type; /* Type of file */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	802 PROffset64 size; /* Size, in bytes, of file's contents */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	803 PRTime creationTime; /* Creation time per definition of PRTime */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	804 PRTime modifyTime; /* Last modification time per definition of PRTime */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	805 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	806
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	807 /****************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	808 * FUNCTION: PR_GetFileInfo, PR_GetFileInfo64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	809 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	810 * Get the information about the file with the given path name. This is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	811 * applicable only to NSFileDesc describing 'file' types (see
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	812 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	813 * const char *fn
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	814 * path name of the file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	815 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	816 * PRFileInfo *info
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	817 * Information about the given file is written into the file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	818 * information object pointer to by 'info'.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	819 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	820 * PR_GetFileInfo returns PR_SUCCESS if file information is successfully
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	821 * obtained, otherwise it returns PR_FAILURE.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	822 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	823 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	824
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	825 NSPR_API(PRStatus) PR_GetFileInfo(const char fn, PRFileInfo info);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	826 NSPR_API(PRStatus) PR_GetFileInfo64(const char fn, PRFileInfo64 info);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	827
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	828 #ifdef MOZ_UNICODE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	829 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	830 * EXPERIMENTAL: This function may be removed in a future release.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	831 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	832 NSPR_API(PRStatus) PR_GetFileInfo64UTF16(const PRUnichar fn, PRFileInfo64 info);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	833 #endif /* MOZ_UNICODE */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	834
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	835 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	836 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	837 * FUNCTION: PR_GetOpenFileInfo, PR_GetOpenFileInfo64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	838 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	839 * Get information about an open file referred to by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	840 * given PRFileDesc object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	841 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	842 * const PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	843 * A reference to a valid, open file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	844 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	845 * Same as PR_GetFileInfo, PR_GetFileInfo64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	846 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	847 * PR_GetFileInfo returns PR_SUCCESS if file information is successfully
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	848 * obtained, otherwise it returns PR_FAILURE.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	849 ***************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	850 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	851
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	852 NSPR_API(PRStatus) PR_GetOpenFileInfo(PRFileDesc fd, PRFileInfo info);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	853 NSPR_API(PRStatus) PR_GetOpenFileInfo64(PRFileDesc fd, PRFileInfo64 info);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	854
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	855 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	856 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	857 * FUNCTION: PR_Rename
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	858 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	859 * Rename a file from the old name 'from' to the new name 'to'.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	860 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	861 * const char *from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	862 * The old name of the file to be renamed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	863 * const char *to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	864 * The new name of the file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	865 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	866 * None.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	867 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	868 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	869 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	870
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	871 NSPR_API(PRStatus) PR_Rename(const char from, const char to);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	872
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	873 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	874 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	875 * FUNCTION: PR_Access
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	876 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	877 * Determine accessibility of a file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	878 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	879 * const char *name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	880 * path name of the file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	881 * PRAccessHow how
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	882 * specifies which access permission to check for.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	883 * It can be one of the following values:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	884 * PR_ACCESS_READ_OK Test for read permission
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	885 * PR_ACCESS_WRITE_OK Test for write permission
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	886 * PR_ACCESS_EXISTS Check existence of file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	887 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	888 * None.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	889 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	890 * PR_SUCCESS is returned if the requested access is permitted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	891 * Otherwise, PR_FAILURE is returned. Additional information
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	892 * regarding the reason for the failure may be retrieved from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	893 * PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	894 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	895 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	896
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	897 typedef enum PRAccessHow {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	898 PR_ACCESS_EXISTS = 1,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	899 PR_ACCESS_WRITE_OK = 2,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	900 PR_ACCESS_READ_OK = 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	901 } PRAccessHow;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	902
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	903 NSPR_API(PRStatus) PR_Access(const char *name, PRAccessHow how);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	904
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	905 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	906 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	907 * FUNCTION: PR_Seek, PR_Seek64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	908 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	909 * Moves read-write file offset
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	910 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	911 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	912 * Pointer to a PRFileDesc object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	913 * PROffset32, PROffset64 offset
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	914 * Specifies a value, in bytes, that is used in conjunction
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	915 * with the 'whence' parameter to set the file pointer. A
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	916 * negative value causes seeking in the reverse direction.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	917 * PRSeekWhence whence
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	918 * Specifies how to interpret the 'offset' parameter in setting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	919 * the file pointer associated with the 'fd' parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	920 * Values for the 'whence' parameter are:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	921 * PR_SEEK_SET Sets the file pointer to the value of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	922 * 'offset' parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	923 * PR_SEEK_CUR Sets the file pointer to its current location
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	924 * plus the value of the offset parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	925 * PR_SEEK_END Sets the file pointer to the size of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	926 * file plus the value of the offset parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	927 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	928 * None.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	929 * RETURN: PROffset32, PROffset64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	930 * Upon successful completion, the resulting pointer location,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	931 * measured in bytes from the beginning of the file, is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	932 * If the PR_Seek() function fails, the file offset remains
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	933 * unchanged, and the returned value is -1. The error code can
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	934 * then be retrieved via PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	935 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	936 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	937
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	938 NSPR_API(PROffset32) PR_Seek(PRFileDesc *fd, PROffset32 offset, PRSeekWhence whence);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	939 NSPR_API(PROffset64) PR_Seek64(PRFileDesc *fd, PROffset64 offset, PRSeekWhence whence);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	940
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	941 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	942 ************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	943 * FUNCTION: PR_Available
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	944 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	945 * Determine the amount of data in bytes available for reading
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	946 * in the given file or socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	947 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	948 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	949 * Pointer to a PRFileDesc object that refers to a file or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	950 * socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	951 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	952 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	953 * RETURN: PRInt32, PRInt64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	954 * Upon successful completion, PR_Available returns the number of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	955 * bytes beyond the current read pointer that is available for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	956 * reading. Otherwise, it returns a -1 and the reason for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	957 * failure can be retrieved via PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	958 ************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	959 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	960
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	961 NSPR_API(PRInt32) PR_Available(PRFileDesc *fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	962 NSPR_API(PRInt64) PR_Available64(PRFileDesc *fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	963
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	964 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	965 ************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	966 * FUNCTION: PR_Sync
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	967 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	968 * Sync any buffered data for a fd to its backing device (disk).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	969 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	970 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	971 * Pointer to a PRFileDesc object that refers to a file or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	972 * socket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	973 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	974 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	975 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	976 * PR_SUCCESS is returned if the requested access is permitted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	977 * Otherwise, PR_FAILURE is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	978 ************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	979 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	980
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	981 NSPR_API(PRStatus) PR_Sync(PRFileDesc *fd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	982
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	983 /************************************************************************/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	984
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	985 struct PRDirEntry {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	986 const char name; / name of entry, relative to directory name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	987 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	988
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	989 #ifdef MOZ_UNICODE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	990 struct PRDirEntryUTF16 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	991 const PRUnichar name; / name of entry in UTF16, relative to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	992 * directory name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	993 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	994 #endif /* MOZ_UNICODE */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	995
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	996 #if !defined(NO_NSPR_10_SUPPORT)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	997 #define PR_DirName(dirEntry) (dirEntry->name)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	998 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	999
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1000 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1001 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1002 * FUNCTION: PR_OpenDir
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1003 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1004 * Open the directory by the given name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1005 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1006 * const char *name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1007 * path name of the directory to be opened
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1008 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1009 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1010 * RETURN: PRDir *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1011 * If the directory is sucessfully opened, a PRDir object is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1012 * dynamically allocated and a pointer to it is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1013 * If the directory cannot be opened, a NULL pointer is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1014 * MEMORY:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1015 * Upon successful completion, the return value points to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1016 * dynamically allocated memory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1017 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1018 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1019
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1020 NSPR_API(PRDir) PR_OpenDir(const char name);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1021
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1022 #ifdef MOZ_UNICODE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1023 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1024 * EXPERIMENTAL: This function may be removed in a future release.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1025 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1026 NSPR_API(PRDirUTF16) PR_OpenDirUTF16(const PRUnichar name);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1027 #endif /* MOZ_UNICODE */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1028
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1029 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1030 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1031 * FUNCTION: PR_ReadDir
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1032 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1033 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1034 * PRDir *dir
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1035 * pointer to a PRDir object that designates an open directory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1036 * PRDirFlags flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1037 * PR_SKIP_NONE Do not skip any files
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1038 * PR_SKIP_DOT Skip the directory entry "." that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1039 * represents the current directory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1040 * PR_SKIP_DOT_DOT Skip the directory entry ".." that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1041 * represents the parent directory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1042 * PR_SKIP_BOTH Skip both '.' and '..'
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1043 * PR_SKIP_HIDDEN Skip hidden files
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1044 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1045 * RETURN: PRDirEntry*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1046 * Returns a pointer to the next entry in the directory. Returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1047 * a NULL pointer upon reaching the end of the directory or when an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1048 * error occurs. The actual reason can be retrieved via PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1049 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1050 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1051
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1052 typedef enum PRDirFlags {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1053 PR_SKIP_NONE = 0x0,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1054 PR_SKIP_DOT = 0x1,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1055 PR_SKIP_DOT_DOT = 0x2,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1056 PR_SKIP_BOTH = 0x3,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1057 PR_SKIP_HIDDEN = 0x4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1058 } PRDirFlags;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1059
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1060 NSPR_API(PRDirEntry) PR_ReadDir(PRDir dir, PRDirFlags flags);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1061
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1062 #ifdef MOZ_UNICODE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1063 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1064 * EXPERIMENTAL: This function may be removed in a future release.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1065 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1066 NSPR_API(PRDirEntryUTF16) PR_ReadDirUTF16(PRDirUTF16 dir, PRDirFlags flags);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1067 #endif /* MOZ_UNICODE */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1068
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1069 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1070 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1071 * FUNCTION: PR_CloseDir
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1072 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1073 * Close the specified directory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1074 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1075 * PRDir *dir
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1076 * The directory to be closed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1077 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1078 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1079 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1080 * If successful, will return a status of PR_SUCCESS. Otherwise
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1081 * a value of PR_FAILURE. The reason for the failure may be re-
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1082 * trieved using PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1083 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1084 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1085
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1086 NSPR_API(PRStatus) PR_CloseDir(PRDir *dir);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1087
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1088 #ifdef MOZ_UNICODE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1089 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1090 * EXPERIMENTAL: This function may be removed in a future release.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1091 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1092 NSPR_API(PRStatus) PR_CloseDirUTF16(PRDirUTF16 *dir);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1093 #endif /* MOZ_UNICODE */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1094
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1095 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1096 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1097 * FUNCTION: PR_MkDir
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1098 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1099 * Create a new directory with the given name and access mode.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1100 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1101 * const char *name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1102 * The name of the directory to be created. All the path components
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1103 * up to but not including the leaf component must already exist.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1104 * PRIntn mode
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1105 * See 'mode' definiton in PR_Open().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1106 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1107 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1108 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1109 * If successful, will return a status of PR_SUCCESS. Otherwise
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1110 * a value of PR_FAILURE. The reason for the failure may be re-
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1111 * trieved using PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1112 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1113 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1114
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1115 NSPR_API(PRStatus) PR_MkDir(const char *name, PRIntn mode);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1116
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1117 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1118 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1119 * FUNCTION: PR_MakeDir
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1120 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1121 * Create a new directory with the given name and access mode.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1122 * PR_MakeDir has the same prototype as PR_MkDir but implements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1123 * the specified access mode where possible.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1124 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1125 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1126
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1127 NSPR_API(PRStatus) PR_MakeDir(const char *name, PRIntn mode);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1128
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1129 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1130 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1131 * FUNCTION: PR_RmDir
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1132 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1133 * Remove a directory by the given name.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1134 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1135 * const char *name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1136 * The name of the directory to be removed. All the path components
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1137 * must already exist. Only the leaf component will be removed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1138 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1139 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1140 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1141 * If successful, will return a status of PR_SUCCESS. Otherwise
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1142 * a value of PR_FAILURE. The reason for the failure may be re-
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1143 * trieved using PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1144 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1145 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1146
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1147 NSPR_API(PRStatus) PR_RmDir(const char *name);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1148
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1149 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1150 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1151 * FUNCTION: PR_NewUDPSocket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1152 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1153 * Create a new UDP socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1154 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1155 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1156 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1157 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1158 * RETURN: PRFileDesc*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1159 * Upon successful completion, PR_NewUDPSocket returns a pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1160 * to the PRFileDesc created for the newly opened UDP socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1161 * Returns a NULL pointer if the creation of a new UDP socket failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1162 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1163 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1164 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1165
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1166 NSPR_API(PRFileDesc*) PR_NewUDPSocket(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1167
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1168 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1169 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1170 * FUNCTION: PR_NewTCPSocket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1171 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1172 * Create a new TCP socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1173 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1174 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1175 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1176 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1177 * RETURN: PRFileDesc*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1178 * Upon successful completion, PR_NewTCPSocket returns a pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1179 * to the PRFileDesc created for the newly opened TCP socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1180 * Returns a NULL pointer if the creation of a new TCP socket failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1181 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1182 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1183 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1184
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1185 NSPR_API(PRFileDesc*) PR_NewTCPSocket(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1186
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1187 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1188 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1189 * FUNCTION: PR_OpenUDPSocket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1190 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1191 * Create a new UDP socket of the specified address family.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1192 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1193 * PRIntn af
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1194 * Address family
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1195 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1196 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1197 * RETURN: PRFileDesc*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1198 * Upon successful completion, PR_OpenUDPSocket returns a pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1199 * to the PRFileDesc created for the newly opened UDP socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1200 * Returns a NULL pointer if the creation of a new UDP socket failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1201 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1202 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1203 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1204
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1205 NSPR_API(PRFileDesc*) PR_OpenUDPSocket(PRIntn af);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1206
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1207 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1208 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1209 * FUNCTION: PR_OpenTCPSocket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1210 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1211 * Create a new TCP socket of the specified address family.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1212 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1213 * PRIntn af
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1214 * Address family
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1215 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1216 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1217 * RETURN: PRFileDesc*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1218 * Upon successful completion, PR_NewTCPSocket returns a pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1219 * to the PRFileDesc created for the newly opened TCP socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1220 * Returns a NULL pointer if the creation of a new TCP socket failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1221 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1222 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1223 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1224
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1225 NSPR_API(PRFileDesc*) PR_OpenTCPSocket(PRIntn af);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1226
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1227 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1228 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1229 * FUNCTION: PR_Connect
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1230 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1231 * Initiate a connection on a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1232 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1233 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1234 * Points to a PRFileDesc object representing a socket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1235 * PRNetAddr *addr
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1236 * Specifies the address of the socket in its own communication
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1237 * space.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1238 * PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1239 * The function uses the lesser of the provided timeout and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1240 * the OS's connect timeout. In particular, if you specify
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1241 * PR_INTERVAL_NO_TIMEOUT as the timeout, the OS's connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1242 * time limit will be used.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1243 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1244 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1245 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1246 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1247 * Upon successful completion of connection initiation, PR_Connect
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1248 * returns PR_SUCCESS. Otherwise, it returns PR_FAILURE. Further
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1249 * failure information can be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1250 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1251 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1252
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1253 NSPR_API(PRStatus) PR_Connect(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1254 PRFileDesc fd, const PRNetAddr addr, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1255
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1256 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1257 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1258 * FUNCTION: PR_ConnectContinue
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1259 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1260 * Continue a nonblocking connect. After a nonblocking connect
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1261 * is initiated with PR_Connect() (which fails with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1262 * PR_IN_PROGRESS_ERROR), one should call PR_Poll() on the socket,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1263 * with the in_flags PR_POLL_WRITE \| PR_POLL_EXCEPT. When
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1264 * PR_Poll() returns, one calls PR_ConnectContinue() on the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1265 * socket to determine whether the nonblocking connect has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1266 * completed or is still in progress. Repeat the PR_Poll(),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1267 * PR_ConnectContinue() sequence until the nonblocking connect
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1268 * has completed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1269 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1270 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1271 * the file descriptor representing a socket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1272 * PRInt16 out_flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1273 * the out_flags field of the poll descriptor returned by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1274 * PR_Poll()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1275 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1276 * If the nonblocking connect has successfully completed,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1277 * PR_ConnectContinue returns PR_SUCCESS. If PR_ConnectContinue()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1278 * returns PR_FAILURE, call PR_GetError():
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1279 * - PR_IN_PROGRESS_ERROR: the nonblocking connect is still in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1280 * progress and has not completed yet. The caller should poll
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1281 * on the file descriptor for the in_flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1282 * PR_POLL_WRITE\|PR_POLL_EXCEPT and retry PR_ConnectContinue
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1283 * later when PR_Poll() returns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1284 * - Other errors: the nonblocking connect has failed with this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1285 * error code.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1286 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1287
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1288 NSPR_API(PRStatus) PR_ConnectContinue(PRFileDesc *fd, PRInt16 out_flags);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1289
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1290 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1291 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1292 * THIS FUNCTION IS DEPRECATED. USE PR_ConnectContinue INSTEAD.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1293 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1294 * FUNCTION: PR_GetConnectStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1295 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1296 * Get the completion status of a nonblocking connect. After
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1297 * a nonblocking connect is initiated with PR_Connect() (which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1298 * fails with PR_IN_PROGRESS_ERROR), one should call PR_Poll()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1299 * on the socket, with the in_flags PR_POLL_WRITE \| PR_POLL_EXCEPT.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1300 * When PR_Poll() returns, one calls PR_GetConnectStatus on the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1301 * PRPollDesc structure to determine whether the nonblocking
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1302 * connect has succeeded or failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1303 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1304 * const PRPollDesc *pd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1305 * Pointer to a PRPollDesc whose fd member is the socket,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1306 * and in_flags must contain PR_POLL_WRITE and PR_POLL_EXCEPT.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1307 * PR_Poll() should have been called and set the out_flags.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1308 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1309 * If the nonblocking connect has successfully completed,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1310 * PR_GetConnectStatus returns PR_SUCCESS. If PR_GetConnectStatus()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1311 * returns PR_FAILURE, call PR_GetError():
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1312 * - PR_IN_PROGRESS_ERROR: the nonblocking connect is still in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1313 * progress and has not completed yet.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1314 * - Other errors: the nonblocking connect has failed with this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1315 * error code.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1316 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1317
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1318 NSPR_API(PRStatus) PR_GetConnectStatus(const PRPollDesc *pd);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1319
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1320 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1321 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1322 * FUNCTION: PR_Accept
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1323 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1324 * Accept a connection on a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1325 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1326 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1327 * Points to a PRFileDesc object representing the rendezvous socket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1328 * on which the caller is willing to accept new connections.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1329 * PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1330 * Time limit for completion of the accept operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1331 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1332 * PRNetAddr *addr
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1333 * Returns the address of the connecting entity in its own
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1334 * communication space. It may be NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1335 * RETURN: PRFileDesc*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1336 * Upon successful acceptance of a connection, PR_Accept
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1337 * returns a valid file descriptor. Otherwise, it returns NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1338 * Further failure information can be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1339 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1340 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1341
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1342 NSPR_API(PRFileDesc*) PR_Accept(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1343 PRFileDesc fd, PRNetAddr addr, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1344
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1345 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1346 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1347 * FUNCTION: PR_Bind
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1348 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1349 * Bind an address to a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1350 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1351 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1352 * Points to a PRFileDesc object representing a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1353 * PRNetAddr *addr
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1354 * Specifies the address to which the socket will be bound.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1355 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1356 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1357 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1358 * Upon successful binding of an address to a socket, PR_Bind
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1359 * returns PR_SUCCESS. Otherwise, it returns PR_FAILURE. Further
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1360 * failure information can be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1361 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1362 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1363
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1364 NSPR_API(PRStatus) PR_Bind(PRFileDesc fd, const PRNetAddr addr);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1365
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1366 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1367 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1368 * FUNCTION: PR_Listen
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1369 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1370 * Listen for connections on a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1371 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1372 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1373 * Points to a PRFileDesc object representing a socket that will be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1374 * used to listen for new connections.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1375 * PRIntn backlog
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1376 * Specifies the maximum length of the queue of pending connections.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1377 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1378 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1379 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1380 * Upon successful completion of listen request, PR_Listen
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1381 * returns PR_SUCCESS. Otherwise, it returns PR_FAILURE. Further
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1382 * failure information can be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1383 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1384 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1385
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1386 NSPR_API(PRStatus) PR_Listen(PRFileDesc *fd, PRIntn backlog);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1387
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1388 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1389 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1390 * FUNCTION: PR_Shutdown
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1391 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1392 * Shut down part of a full-duplex connection on a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1393 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1394 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1395 * Points to a PRFileDesc object representing a connected socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1396 * PRIntn how
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1397 * Specifies the kind of disallowed operations on the socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1398 * PR_SHUTDOWN_RCV - Further receives will be disallowed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1399 * PR_SHUTDOWN_SEND - Further sends will be disallowed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1400 * PR_SHUTDOWN_BOTH - Further sends and receives will be disallowed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1401 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1402 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1403 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1404 * Upon successful completion of shutdown request, PR_Shutdown
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1405 * returns PR_SUCCESS. Otherwise, it returns PR_FAILURE. Further
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1406 * failure information can be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1407 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1408 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1409
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1410 typedef enum PRShutdownHow
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1411 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1412 PR_SHUTDOWN_RCV = 0, /* disallow further receives */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1413 PR_SHUTDOWN_SEND = 1, /* disallow further sends */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1414 PR_SHUTDOWN_BOTH = 2 /* disallow further receives and sends */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1415 } PRShutdownHow;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1416
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1417 NSPR_API(PRStatus) PR_Shutdown(PRFileDesc *fd, PRShutdownHow how);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1418
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1419 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1420 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1421 * FUNCTION: PR_Recv
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1422 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1423 * Receive a specified number of bytes from a connected socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1424 * The operation will block until some positive number of bytes are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1425 * transferred, a time out has occurred, or there is an error.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1426 * No more than 'amount' bytes will be transferred.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1427 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1428 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1429 * points to a PRFileDesc object representing a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1430 * void *buf
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1431 * pointer to a buffer to hold the data received.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1432 * PRInt32 amount
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1433 * the size of 'buf' (in bytes)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1434 * PRIntn flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1435 * must be zero or PR_MSG_PEEK.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1436 * PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1437 * Time limit for completion of the receive operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1438 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1439 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1440 * RETURN: PRInt32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1441 * a positive number indicates the number of bytes actually received.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1442 * 0 means the network connection is closed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1443 * -1 indicates a failure. The reason for the failure is obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1444 * by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1445 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1446 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1447
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1448 #define PR_MSG_PEEK 0x2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1449
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1450 NSPR_API(PRInt32) PR_Recv(PRFileDesc fd, void buf, PRInt32 amount,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1451 PRIntn flags, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1452
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1453 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1454 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1455 * FUNCTION: PR_Send
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1456 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1457 * Send a specified number of bytes from a connected socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1458 * The operation will block until all bytes are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1459 * processed, a time out has occurred, or there is an error.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1460 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1461 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1462 * points to a PRFileDesc object representing a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1463 * void *buf
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1464 * pointer to a buffer from where the data is sent.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1465 * PRInt32 amount
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1466 * the size of 'buf' (in bytes)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1467 * PRIntn flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1468 * (OBSOLETE - must always be zero)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1469 * PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1470 * Time limit for completion of the send operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1471 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1472 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1473 * RETURN: PRInt32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1474 * A positive number indicates the number of bytes successfully processed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1475 * This number must always equal 'amount'. A -1 is an indication that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1476 * operation failed. The reason for the failure is obtained by calling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1477 * PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1478 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1479 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1480
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1481 NSPR_API(PRInt32) PR_Send(PRFileDesc fd, const void buf, PRInt32 amount,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1482 PRIntn flags, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1483
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1484 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1485 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1486 * FUNCTION: PR_RecvFrom
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1487 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1488 * Receive up to a specified number of bytes from socket which may
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1489 * or may not be connected.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1490 * The operation will block until one or more bytes are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1491 * transferred, a time out has occurred, or there is an error.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1492 * No more than 'amount' bytes will be transferred.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1493 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1494 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1495 * points to a PRFileDesc object representing a socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1496 * void *buf
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1497 * pointer to a buffer to hold the data received.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1498 * PRInt32 amount
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1499 * the size of 'buf' (in bytes)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1500 * PRIntn flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1501 * (OBSOLETE - must always be zero)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1502 * PRNetAddr *addr
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1503 * Specifies the address of the sending peer. It may be NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1504 * PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1505 * Time limit for completion of the receive operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1506 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1507 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1508 * RETURN: PRInt32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1509 * a positive number indicates the number of bytes actually received.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1510 * 0 means the network connection is closed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1511 * -1 indicates a failure. The reason for the failure is obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1512 * by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1513 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1514 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1515
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1516 NSPR_API(PRInt32) PR_RecvFrom(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1517 PRFileDesc fd, void buf, PRInt32 amount, PRIntn flags,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1518 PRNetAddr *addr, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1519
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1520 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1521 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1522 * FUNCTION: PR_SendTo
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1523 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1524 * Send a specified number of bytes from an unconnected socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1525 * The operation will block until all bytes are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1526 * sent, a time out has occurred, or there is an error.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1527 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1528 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1529 * points to a PRFileDesc object representing an unconnected socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1530 * void *buf
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1531 * pointer to a buffer from where the data is sent.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1532 * PRInt32 amount
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1533 * the size of 'buf' (in bytes)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1534 * PRIntn flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1535 * (OBSOLETE - must always be zero)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1536 * PRNetAddr *addr
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1537 * Specifies the address of the peer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1538 .* PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1539 * Time limit for completion of the send operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1540 * OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1541 * None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1542 * RETURN: PRInt32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1543 * A positive number indicates the number of bytes successfully sent.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1544 * -1 indicates a failure. The reason for the failure is obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1545 * by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1546 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1547 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1548
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1549 NSPR_API(PRInt32) PR_SendTo(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1550 PRFileDesc fd, const void buf, PRInt32 amount, PRIntn flags,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1551 const PRNetAddr *addr, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1552
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1553 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1554 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1555 ** FUNCTION: PR_TransmitFile
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1556 ** DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1557 ** Transmitfile sends a complete file (sourceFile) across a socket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1558 ** (networkSocket). If headers is non-NULL, the headers will be sent across
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1559 ** the socket prior to sending the file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1560 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1561 ** Optionally, the PR_TRANSMITFILE_CLOSE_SOCKET flag may be passed to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1562 ** transmitfile. This flag specifies that transmitfile should close the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1563 ** socket after sending the data.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1564 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1565 ** INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1566 ** PRFileDesc *networkSocket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1567 ** The socket to send data over
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1568 ** PRFileDesc *sourceFile
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1569 ** The file to send
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1570 ** const void *headers
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1571 ** A pointer to headers to be sent before sending data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1572 ** PRInt32 hlen
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1573 ** length of header buffers in bytes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1574 ** PRTransmitFileFlags flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1575 ** If the flags indicate that the connection should be closed,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1576 ** it will be done immediately after transferring the file, unless
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1577 ** the operation is unsuccessful.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1578 .* PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1579 * Time limit for completion of the transmit operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1580 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1581 ** RETURNS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1582 ** Returns the number of bytes written or -1 if the operation failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1583 ** If an error occurs while sending the file, the PR_TRANSMITFILE_CLOSE_
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1584 ** SOCKET flag is ignored. The reason for the failure is obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1585 ** by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1586 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1587 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1588
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1589 NSPR_API(PRInt32) PR_TransmitFile(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1590 PRFileDesc networkSocket, PRFileDesc sourceFile,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1591 const void *headers, PRInt32 hlen, PRTransmitFileFlags flags,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1592 PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1593
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1594 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1595 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1596 ** FUNCTION: PR_SendFile
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1597 ** DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1598 ** PR_SendFile sends data from a file (sendData->fd) across a socket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1599 ** (networkSocket). If specified, a header and/or trailer buffer are sent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1600 ** before and after the file, respectively. The file offset, number of bytes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1601 ** of file data to send, the header and trailer buffers are specified in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1602 ** sendData argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1603 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1604 ** Optionally, if the PR_TRANSMITFILE_CLOSE_SOCKET flag is passed, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1605 ** socket is closed after successfully sending the data.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1606 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1607 ** INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1608 ** PRFileDesc *networkSocket
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1609 ** The socket to send data over
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1610 ** PRSendFileData *sendData
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1611 ** Contains the FD, file offset and length, header and trailer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1612 ** buffer specifications.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1613 ** PRTransmitFileFlags flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1614 ** If the flags indicate that the connection should be closed,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1615 ** it will be done immediately after transferring the file, unless
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1616 ** the operation is unsuccessful.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1617 .* PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1618 * Time limit for completion of the send operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1619 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1620 ** RETURNS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1621 ** Returns the number of bytes written or -1 if the operation failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1622 ** If an error occurs while sending the file, the PR_TRANSMITFILE_CLOSE_
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1623 ** SOCKET flag is ignored. The reason for the failure is obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1624 ** by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1625 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1626 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1627
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1628 struct PRSendFileData {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1629 PRFileDesc fd; / file to send */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1630 PRUint32 file_offset; /* file offset */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1631 PRSize file_nbytes; /* number of bytes of file data to send */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1632 /* if 0, send data from file_offset to */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1633 /* end-of-file. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1634 const void header; / header buffer */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1635 PRInt32 hlen; /* header len */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1636 const void trailer; / trailer buffer */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1637 PRInt32 tlen; /* trailer len */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1638 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1639
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1640
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1641 NSPR_API(PRInt32) PR_SendFile(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1642 PRFileDesc networkSocket, PRSendFileData sendData,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1643 PRTransmitFileFlags flags, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1644
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1645 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1646 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1647 ** FUNCTION: PR_AcceptRead
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1648 ** DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1649 ** AcceptRead accepts a new connection, returns the newly created
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1650 ** socket's descriptor and also returns the connecting peer's address.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1651 ** AcceptRead, as its name suggests, also receives the first block of data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1652 ** sent by the peer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1653 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1654 ** INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1655 ** PRFileDesc *listenSock
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1656 ** A socket descriptor that has been called with the PR_Listen()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1657 ** function, also known as the rendezvous socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1658 ** void *buf
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1659 ** A pointer to a buffer to receive data sent by the client. This
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1660 ** buffer must be large enough to receive <amount> bytes of data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1661 ** and two PRNetAddr structures, plus an extra 32 bytes. See:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1662 ** PR_ACCEPT_READ_BUF_OVERHEAD.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1663 ** PRInt32 amount
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1664 ** The number of bytes of client data to receive. Does not include
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1665 ** the size of the PRNetAddr structures. If 0, no data will be read
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1666 ** from the client.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1667 ** PRIntervalTime timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1668 ** The timeout interval only applies to the read portion of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1669 ** operation. PR_AcceptRead will block indefinitely until the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1670 ** connection is accepted; the read will timeout after the timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1671 ** interval elapses.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1672 ** OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1673 PRFileDesc acceptedSock
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1674 ** The file descriptor for the newly connected socket. This parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1675 ** will only be valid if the function return does not indicate failure.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1676 PRNetAddr peerAddr,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1677 ** The address of the remote socket. This parameter will only be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1678 ** valid if the function return does not indicate failure. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1679 ** returned address is not guaranteed to be properly aligned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1680 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1681 ** RETURNS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1682 ** The number of bytes read from the client or -1 on failure. The reason
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1683 ** for the failure is obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1684 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1685 **/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1686 /* define buffer overhead constant. Add this value to the user's
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1687 ** data length when allocating a buffer to accept data.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1688 ** Example:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1689 ** #define USER_DATA_SIZE 10
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1690 ** char buf[USER_DATA_SIZE + PR_ACCEPT_READ_BUF_OVERHEAD];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1691 ** bytesRead = PR_AcceptRead( s, fd, &a, &p, USER_DATA_SIZE, ...);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1692 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1693 #define PR_ACCEPT_READ_BUF_OVERHEAD (32+(2*sizeof(PRNetAddr)))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1694
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1695 NSPR_API(PRInt32) PR_AcceptRead(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1696 PRFileDesc listenSock, PRFileDesc *acceptedSock,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1697 PRNetAddr *peerAddr, void buf, PRInt32 amount, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1698
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1699 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1700 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1701 ** FUNCTION: PR_NewTCPSocketPair
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1702 ** DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1703 ** Create a new TCP socket pair. The returned descriptors can be used
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1704 ** interchangeably; they are interconnected full-duplex descriptors: data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1705 ** written to one can be read from the other and vice-versa.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1706 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1707 ** INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1708 ** None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1709 ** OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1710 ** PRFileDesc *fds[2]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1711 ** The file descriptor pair for the newly created TCP sockets.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1712 ** RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1713 ** Upon successful completion of TCP socket pair, PR_NewTCPSocketPair
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1714 ** returns PR_SUCCESS. Otherwise, it returns PR_FAILURE. Further
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1715 ** failure information can be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1716 ** XXX can we implement this on windoze and mac?
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1717 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1718 **/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1719 NSPR_API(PRStatus) PR_NewTCPSocketPair(PRFileDesc *fds[2]);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1720
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1721 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1722 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1723 ** FUNCTION: PR_GetSockName
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1724 ** DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1725 ** Get socket name. Return the network address for this socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1726 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1727 ** INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1728 ** PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1729 ** Points to a PRFileDesc object representing the socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1730 ** OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1731 ** PRNetAddr *addr
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1732 ** Returns the address of the socket in its own communication space.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1733 ** RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1734 ** Upon successful completion, PR_GetSockName returns PR_SUCCESS.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1735 ** Otherwise, it returns PR_FAILURE. Further failure information can
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1736 ** be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1737 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1738 **/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1739 NSPR_API(PRStatus) PR_GetSockName(PRFileDesc fd, PRNetAddr addr);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1740
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1741 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1742 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1743 ** FUNCTION: PR_GetPeerName
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1744 ** DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1745 ** Get name of the connected peer. Return the network address for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1746 ** connected peer socket.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1747 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1748 ** INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1749 ** PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1750 ** Points to a PRFileDesc object representing the connected peer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1751 ** OUTPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1752 ** PRNetAddr *addr
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1753 ** Returns the address of the connected peer in its own communication
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1754 ** space.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1755 ** RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1756 ** Upon successful completion, PR_GetPeerName returns PR_SUCCESS.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1757 ** Otherwise, it returns PR_FAILURE. Further failure information can
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1758 ** be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1759 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1760 **/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1761 NSPR_API(PRStatus) PR_GetPeerName(PRFileDesc fd, PRNetAddr addr);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1762
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1763 NSPR_API(PRStatus) PR_GetSocketOption(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1764 PRFileDesc fd, PRSocketOptionData data);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1765
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1766 NSPR_API(PRStatus) PR_SetSocketOption(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1767 PRFileDesc fd, const PRSocketOptionData data);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1768
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1769 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1770 *********************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1771 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1772 * File descriptor inheritance
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1773 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1774 *********************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1775 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1776
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1777 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1778 ************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1779 * FUNCTION: PR_SetFDInheritable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1780 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1781 * Set the inheritance attribute of a file descriptor.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1782 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1783 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1784 * PRFileDesc *fd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1785 * Points to a PRFileDesc object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1786 * PRBool inheritable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1787 * If PR_TRUE, the file descriptor fd is set to be inheritable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1788 * by a child process. If PR_FALSE, the file descriptor is set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1789 * to be not inheritable by a child process.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1790 * RETURN: PRStatus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1791 * Upon successful completion, PR_SetFDInheritable returns PR_SUCCESS.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1792 * Otherwise, it returns PR_FAILURE. Further failure information can
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1793 * be obtained by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1794 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1795 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1796 NSPR_API(PRStatus) PR_SetFDInheritable(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1797 PRFileDesc *fd,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1798 PRBool inheritable);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1799
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1800 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1801 ************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1802 * FUNCTION: PR_GetInheritedFD
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1803 * DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1804 * Get an inherited file descriptor with the specified name.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1805 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1806 * INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1807 * const char *name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1808 * The name of the inherited file descriptor.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1809 * RETURN: PRFileDesc *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1810 * Upon successful completion, PR_GetInheritedFD returns the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1811 * inherited file descriptor with the specified name. Otherwise,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1812 * it returns NULL. Further failure information can be obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1813 * by calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1814 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1815 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1816 NSPR_API(PRFileDesc ) PR_GetInheritedFD(const char name);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1817
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1818 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1819 *********************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1820 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1821 * Memory-mapped files
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1822 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1823 *********************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1824 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1825
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1826 typedef struct PRFileMap PRFileMap;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1827
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1828 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1829 * protection options for read and write accesses of a file mapping
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1830 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1831 typedef enum PRFileMapProtect {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1832 PR_PROT_READONLY, /* read only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1833 PR_PROT_READWRITE, /* readable, and write is shared */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1834 PR_PROT_WRITECOPY /* readable, and write is private (copy-on-write) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1835 } PRFileMapProtect;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1836
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1837 NSPR_API(PRFileMap *) PR_CreateFileMap(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1838 PRFileDesc *fd,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1839 PRInt64 size,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1840 PRFileMapProtect prot);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1841
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1842 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1843 * return the alignment (in bytes) of the offset argument to PR_MemMap
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1844 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1845 NSPR_API(PRInt32) PR_GetMemMapAlignment(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1846
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1847 NSPR_API(void *) PR_MemMap(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1848 PRFileMap *fmap,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1849 PROffset64 offset, /* must be aligned and sized according to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1850 * return value of PR_GetMemMapAlignment() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1851 PRUint32 len);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1852
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1853 NSPR_API(PRStatus) PR_MemUnmap(void *addr, PRUint32 len);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1854
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1855 NSPR_API(PRStatus) PR_CloseFileMap(PRFileMap *fmap);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1856
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1857 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1858 * Synchronously flush the given memory-mapped address range of the given open
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1859 * file to disk. The function does not return until all modified data have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1860 * been written to disk.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1861 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1862 * On some platforms, the function will call PR_Sync(fd) internally if it is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1863 * necessary for flushing modified data to disk synchronously.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1864 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1865 NSPR_API(PRStatus) PR_SyncMemMap(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1866 PRFileDesc *fd,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1867 void *addr,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1868 PRUint32 len);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1869
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1870 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1871 ******************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1872 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1873 * Interprocess communication
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1874 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1875 ******************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1876 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1877
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1878 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1879 * Creates an anonymous pipe and returns file descriptors for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1880 * read and write ends of the pipe.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1881 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1882
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1883 NSPR_API(PRStatus) PR_CreatePipe(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1884 PRFileDesc **readPipe,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1885 PRFileDesc **writePipe
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1886 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1887
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1888 /************************************************************************/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1889 /************ The following definitions are for poll ****************/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1890 /************************************************************************/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1891
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1892 struct PRPollDesc {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1893 PRFileDesc* fd;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1894 PRInt16 in_flags;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1895 PRInt16 out_flags;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1896 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1897
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1898 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1899 ** Bit values for PRPollDesc.in_flags or PRPollDesc.out_flags. Binary-or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1900 ** these together to produce the desired poll request.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1901 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1902
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1903 #if defined(_PR_POLL_BACKCOMPAT)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1904
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1905 #include <poll.h>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1906 #define PR_POLL_READ POLLIN
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1907 #define PR_POLL_WRITE POLLOUT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1908 #define PR_POLL_EXCEPT POLLPRI
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1909 #define PR_POLL_ERR POLLERR /* only in out_flags */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1910 #define PR_POLL_NVAL POLLNVAL /* only in out_flags when fd is bad */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1911 #define PR_POLL_HUP POLLHUP /* only in out_flags */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1912
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1913 #else /* _PR_POLL_BACKCOMPAT */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1914
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1915 #define PR_POLL_READ 0x1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1916 #define PR_POLL_WRITE 0x2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1917 #define PR_POLL_EXCEPT 0x4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1918 #define PR_POLL_ERR 0x8 /* only in out_flags */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1919 #define PR_POLL_NVAL 0x10 /* only in out_flags when fd is bad */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1920 #define PR_POLL_HUP 0x20 /* only in out_flags */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1921
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1922 #endif /* _PR_POLL_BACKCOMPAT */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1923
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1924 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1925 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1926 ** FUNCTION: PR_Poll
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1927 ** DESCRIPTION:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1928 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1929 ** The call returns as soon as I/O is ready on one or more of the underlying
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1930 ** socket objects. A count of the number of ready descriptors is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1931 ** returned unless a timeout occurs in which case zero is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1932 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1933 ** PRPollDesc.fd should be set to a pointer to a PRFileDesc object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1934 ** representing a socket. This field can be set to NULL to indicate to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1935 ** PR_Poll that this PRFileDesc object should be ignored.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1936 ** PRPollDesc.in_flags should be set to the desired request
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1937 ** (read/write/except or some combination). Upon successful return from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1938 ** this call PRPollDesc.out_flags will be set to indicate what kind of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1939 ** i/o can be performed on the respective descriptor. PR_Poll() uses the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1940 ** out_flags fields as scratch variables during the call. If PR_Poll()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1941 ** returns 0 or -1, the out_flags fields do not contain meaningful values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1942 ** and must not be used.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1943 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1944 ** INPUTS:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1945 ** PRPollDesc *pds A pointer to an array of PRPollDesc
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1946 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1947 ** PRIntn npds The number of elements in the array
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1948 ** If this argument is zero PR_Poll is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1949 ** equivalent to a PR_Sleep(timeout).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1950 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1951 ** PRIntervalTime timeout Amount of time the call will block waiting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1952 ** for I/O to become ready. If this time expires
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1953 ** w/o any I/O becoming ready, the result will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1954 ** be zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1955 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1956 ** OUTPUTS: None
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1957 ** RETURN:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1958 ** PRInt32 Number of PRPollDesc's with events or zero
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1959 ** if the function timed out or -1 on failure.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1960 ** The reason for the failure is obtained by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1961 ** calling PR_GetError().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1962 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1963 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1964 NSPR_API(PRInt32) PR_Poll(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1965 PRPollDesc *pds, PRIntn npds, PRIntervalTime timeout);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1966
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1967 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1968 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1969 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1970 ** Pollable events
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1971 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1972 ** A pollable event is a special kind of file descriptor.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1973 ** The only I/O operation you can perform on a pollable event
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1974 ** is to poll it with the PR_POLL_READ flag. You can't
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1975 ** read from or write to a pollable event.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1976 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1977 ** The purpose of a pollable event is to combine event waiting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1978 ** with I/O waiting in a single PR_Poll call. Pollable events
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1979 ** are implemented using a pipe or a pair of TCP sockets
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1980 ** connected via the loopback address, therefore setting and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1981 ** waiting for pollable events are expensive operating system
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1982 ** calls. Do not use pollable events for general thread
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1983 ** synchronization. Use condition variables instead.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1984 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1985 ** A pollable event has two states: set and unset. Events
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1986 ** are not queued, so there is no notion of an event count.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1987 ** A pollable event is either set or unset.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1988 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1989 ** A new pollable event is created by a PR_NewPollableEvent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1990 ** call and is initially in the unset state.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1991 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1992 ** PR_WaitForPollableEvent blocks the calling thread until
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1993 ** the pollable event is set, and then it atomically unsets
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1994 ** the pollable event before it returns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1995 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1996 ** To set a pollable event, call PR_SetPollableEvent.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1997 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1998 ** One can call PR_Poll with the PR_POLL_READ flag on a pollable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1999 ** event. When the pollable event is set, PR_Poll returns with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2000 ** the PR_POLL_READ flag set in the out_flags.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2001 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2002 ** To close a pollable event, call PR_DestroyPollableEvent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2003 ** (not PR_Close).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2004 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2005 **************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2006 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2007
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2008 NSPR_API(PRFileDesc *) PR_NewPollableEvent(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2009
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2010 NSPR_API(PRStatus) PR_DestroyPollableEvent(PRFileDesc *event);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2011
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2012 NSPR_API(PRStatus) PR_SetPollableEvent(PRFileDesc *event);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2013
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2014 NSPR_API(PRStatus) PR_WaitForPollableEvent(PRFileDesc *event);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2015
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2016 PR_END_EXTERN_C
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2017
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2018 #endif /* prio_h___ */

Mercurial > trustbridge > nss-cmake-static

annotate nspr/pr/include/prio.h @ 3:150b72113545