blob: bad5947429fac6c5decdb65f7f9591f3eb2c9f97 [file] [log] [blame]
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
* The Original Code is the Netscape Portable Runtime (NSPR).
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998-2000
* the Initial Developer. All Rights Reserved.
* Contributor(s):
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
* ***** END LICENSE BLOCK ***** */
** A collection of things thought to be obsolete
#if defined(PROBSLET_H)
#define PROBSLET_H
#include "prio.h"
#include "private/pprio.h" /* for PROsfd */
** Yield the current thread. The proper function to use in place of
** PR_Yield() is PR_Sleep() with an argument of PR_INTERVAL_NO_WAIT.
NSPR_API(PRStatus) PR_Yield(void);
/************* The following definitions are for select *****************/
** The following is obsolete and will be deleted in the next release!
** These are provided for compatibility, but are GUARANTEED to be slow.
** Override PR_MAX_SELECT_DESC if you need more space in the select set.
#define PR_MAX_SELECT_DESC 1024
typedef struct PR_fd_set {
PRUint32 hsize;
PRFileDesc *harray[PR_MAX_SELECT_DESC];
PRUint32 nsize;
} PR_fd_set;
** FUNCTION: PR_Select
** The call returns as soon as I/O is ready on one or more of the underlying
** file/socket descriptors or an exceptional condition is pending. A count of the
** number of ready descriptors is returned unless a timeout occurs in which case
** zero is returned. On return, PR_Select replaces the given descriptor sets with
** subsets consisting of those descriptors that are ready for the requested condition.
** The total number of ready descriptors in all the sets is the return value.
** PRInt32 num
** This argument is unused but is provided for select(unix) interface
** compatability. All input PR_fd_set arguments are self-describing
** with its own maximum number of elements in the set.
** PR_fd_set *readfds
** A set describing the io descriptors for which ready for reading
** condition is of interest.
** PR_fd_set *writefds
** A set describing the io descriptors for which ready for writing
** condition is of interest.
** PR_fd_set *exceptfds
** A set describing the io descriptors for which exception pending
** condition is of interest.
** Any of the above readfds, writefds or exceptfds may be given as NULL
** pointers if no descriptors are of interest for that particular condition.
** PRIntervalTime timeout
** Amount of time the call will block waiting for I/O to become ready.
** If this time expires without any I/O becoming ready, the result will
** be zero.
** PR_fd_set *readfds
** A set describing the io descriptors which are ready for reading.
** PR_fd_set *writefds
** A set describing the io descriptors which are ready for writing.
** PR_fd_set *exceptfds
** A set describing the io descriptors which have pending exception.
** Number of io descriptors with asked for conditions or zero if the function
** timed out or -1 on failure. The reason for the failure is obtained by
** calling PR_GetError().
** XXX can we implement this on windoze and mac?
NSPR_API(PRInt32) PR_Select(
PRInt32 num, PR_fd_set *readfds, PR_fd_set *writefds,
PR_fd_set *exceptfds, PRIntervalTime timeout);
** The following are not thread safe for two threads operating on them at the
** same time.
** The following routines are provided for manipulating io descriptor sets.
** PR_FD_ZERO(&fdset) initializes a descriptor set fdset to the null set.
** PR_FD_SET(fd, &fdset) includes a particular file descriptor fd in fdset.
** PR_FD_CLR(fd, &fdset) removes a file descriptor fd from fdset.
** PR_FD_ISSET(fd, &fdset) is nonzero if file descriptor fd is a member of
** fdset, zero otherwise.
** PR_FD_NSET(osfd, &fdset) includes a particular native file descriptor osfd
** in fdset.
** PR_FD_NCLR(osfd, &fdset) removes a native file descriptor osfd from fdset.
** PR_FD_NISSET(osfd, &fdset) is nonzero if native file descriptor osfd is a member of
** fdset, zero otherwise.
NSPR_API(void) PR_FD_ZERO(PR_fd_set *set);
NSPR_API(void) PR_FD_SET(PRFileDesc *fd, PR_fd_set *set);
NSPR_API(void) PR_FD_CLR(PRFileDesc *fd, PR_fd_set *set);
NSPR_API(PRInt32) PR_FD_ISSET(PRFileDesc *fd, PR_fd_set *set);
NSPR_API(void) PR_FD_NSET(PROsfd osfd, PR_fd_set *set);
NSPR_API(void) PR_FD_NCLR(PROsfd osfd, PR_fd_set *set);
NSPR_API(PRInt32) PR_FD_NISSET(PROsfd osfd, PR_fd_set *set);
** The next two entry points should not be in the API, but they are
** declared here for historical reasons.
NSPR_API(PRInt32) PR_GetSysfdTableMax(void);
NSPR_API(PRInt32) PR_SetSysfdTableSize(PRIntn table_size);
#ifndef NO_NSPR_10_SUPPORT
#include <sys/stat.h>
NSPR_API(PRInt32) PR_Stat(const char *path, struct stat *buf);
#endif /* NO_NSPR_10_SUPPORT */
#endif /* defined(PROBSLET_H) */
/* probslet.h */