15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The contents of this file are subject to the Mozilla Public 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * License Version 1.1 (the "License"); you may not use this file 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * except in compliance with the License. You may obtain a copy of 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the License at http://www.mozilla.org/MPL/ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Software distributed under the License is distributed on an "AS 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * implied. See the License for the specific language governing 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * rights and limitations under the License. 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The Original Code is the Netscape Portable Runtime (NSPR). 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The Initial Developer of the Original Code is Netscape 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Communications Corporation. Portions created by Netscape are 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Copyright (C) 1998-2000 Netscape Communications Corporation. All 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Rights Reserved. 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Contributor(s): 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Alternatively, the contents of this file may be used under the 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * terms of the GNU General Public License Version 2 or later (the 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * "GPL"), in which case the provisions of the GPL are applicable 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * instead of those above. If you wish to allow use of your 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * version of this file only under the terms of the GPL and not to 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * allow others to use your version of this file under the MPL, 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * indicate your decision by deleting the provisions above and 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * replace them with the notice and other provisions required by 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the GPL. If you do not delete the provisions above, a recipient 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * may use your version of this file under either the MPL or the 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * GPL. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** A collection of things thought to be obsolete 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(PROBSLET_H) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PROBSLET_H 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "prio.h" 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PR_BEGIN_EXTERN_C 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** Yield the current thread. The proper function to use in place of 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_Yield() is PR_Sleep() with an argument of PR_INTERVAL_NO_WAIT. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(PRStatus) PR_Yield(void); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/************************************************************************/ 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/************* The following definitions are for select *****************/ 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/************************************************************************/ 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** The following is obsolete and will be deleted in the next release! 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** These are provided for compatibility, but are GUARANTEED to be slow. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** Override PR_MAX_SELECT_DESC if you need more space in the select set. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef PR_MAX_SELECT_DESC 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PR_MAX_SELECT_DESC 1024 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct PR_fd_set { 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PRUint32 hsize; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PRFileDesc *harray[PR_MAX_SELECT_DESC]; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PRUint32 nsize; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PRInt32 narray[PR_MAX_SELECT_DESC]; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} PR_fd_set; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)************************************************************************* 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** FUNCTION: PR_Select 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** DESCRIPTION: 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** The call returns as soon as I/O is ready on one or more of the underlying 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** file/socket descriptors or an exceptional condition is pending. A count of the 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** number of ready descriptors is returned unless a timeout occurs in which case 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** zero is returned. On return, PR_Select replaces the given descriptor sets with 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** subsets consisting of those descriptors that are ready for the requested condition. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** The total number of ready descriptors in all the sets is the return value. 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** INPUTS: 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PRInt32 num 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** This argument is unused but is provided for select(unix) interface 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** compatability. All input PR_fd_set arguments are self-describing 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** with its own maximum number of elements in the set. 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_fd_set *readfds 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** A set describing the io descriptors for which ready for reading 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** condition is of interest. 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_fd_set *writefds 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** A set describing the io descriptors for which ready for writing 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** condition is of interest. 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_fd_set *exceptfds 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** A set describing the io descriptors for which exception pending 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** condition is of interest. 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** Any of the above readfds, writefds or exceptfds may be given as NULL 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** pointers if no descriptors are of interest for that particular condition. 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PRIntervalTime timeout 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** Amount of time the call will block waiting for I/O to become ready. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** If this time expires without any I/O becoming ready, the result will 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** be zero. 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** OUTPUTS: 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_fd_set *readfds 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** A set describing the io descriptors which are ready for reading. 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_fd_set *writefds 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** A set describing the io descriptors which are ready for writing. 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_fd_set *exceptfds 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** A set describing the io descriptors which have pending exception. 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** RETURN:PRInt32 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** Number of io descriptors with asked for conditions or zero if the function 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** timed out or -1 on failure. The reason for the failure is obtained by 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** calling PR_GetError(). 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** XXX can we implement this on windoze and mac? 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)************************************************************************** 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(PRInt32) PR_Select( 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PRInt32 num, PR_fd_set *readfds, PR_fd_set *writefds, 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PR_fd_set *exceptfds, PRIntervalTime timeout); 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** The following are not thread safe for two threads operating on them at the 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** same time. 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** The following routines are provided for manipulating io descriptor sets. 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_FD_ZERO(&fdset) initializes a descriptor set fdset to the null set. 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_FD_SET(fd, &fdset) includes a particular file descriptor fd in fdset. 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_FD_CLR(fd, &fdset) removes a file descriptor fd from fdset. 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_FD_ISSET(fd, &fdset) is nonzero if file descriptor fd is a member of 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** fdset, zero otherwise. 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_FD_NSET(osfd, &fdset) includes a particular native file descriptor osfd 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** in fdset. 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_FD_NCLR(osfd, &fdset) removes a native file descriptor osfd from fdset. 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** PR_FD_NISSET(osfd, &fdset) is nonzero if native file descriptor osfd is a member of 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** fdset, zero otherwise. 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(void) PR_FD_ZERO(PR_fd_set *set); 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(void) PR_FD_SET(PRFileDesc *fd, PR_fd_set *set); 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(void) PR_FD_CLR(PRFileDesc *fd, PR_fd_set *set); 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(PRInt32) PR_FD_ISSET(PRFileDesc *fd, PR_fd_set *set); 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(void) PR_FD_NSET(PRInt32 osfd, PR_fd_set *set); 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(void) PR_FD_NCLR(PRInt32 osfd, PR_fd_set *set); 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(PRInt32) PR_FD_NISSET(PRInt32 osfd, PR_fd_set *set); 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NO_NSPR_10_SUPPORT 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef XP_MAC 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stat.h> 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/stat.h> 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)NSPR_API(PRInt32) PR_Stat(const char *path, struct stat *buf); 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* NO_NSPR_10_SUPPORT */ 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PR_END_EXTERN_C 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* defined(PROBSLET_H) */ 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* probslet.h */ 173