diff options
Diffstat (limited to 'nsprpub/pr/include/obsolete')
-rw-r--r-- | nsprpub/pr/include/obsolete/pralarm.h | 28 | ||||
-rw-r--r-- | nsprpub/pr/include/obsolete/probslet.h | 48 | ||||
-rw-r--r-- | nsprpub/pr/include/obsolete/protypes.h | 32 | ||||
-rw-r--r-- | nsprpub/pr/include/obsolete/prsem.h | 26 |
4 files changed, 59 insertions, 75 deletions
diff --git a/nsprpub/pr/include/obsolete/pralarm.h b/nsprpub/pr/include/obsolete/pralarm.h index 959e74bed1..9ae3a4bcf0 100644 --- a/nsprpub/pr/include/obsolete/pralarm.h +++ b/nsprpub/pr/include/obsolete/pralarm.h @@ -4,11 +4,11 @@ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ /* -** File: pralarm.h -** Description: API to periodic alarms. +** File: pralarm.h +** Description: API to periodic alarms. ** ** -** Alarms are defined to invoke some client specified function at +** Alarms are defined to invoke some client specified function at ** a time in the future. The notification may be a one time event ** or repeated at a fixed interval. The interval at which the next ** notification takes place may be modified by the client code only @@ -57,14 +57,14 @@ typedef PRBool (PR_CALLBACK *PRPeriodicAlarmFn)( ** INPUTS: void ** OUTPUTS: None ** RETURN: PRAlarm* -** +** ** SIDE EFFECTS: ** This creates an alarm context, which is an object used for subsequent ** notification creations. It also creates a thread that will be used to ** deliver the notifications that are expected to be defined. The client ** is resposible for destroying the context when appropriate. ** RESTRICTIONS: -** None. +** None. ** MEMORY: The object (PRAlarm) and a thread to support notifications. ** ALGORITHM: N/A ***********************************************************************/ @@ -77,14 +77,14 @@ NSPR_API(PRAlarm*) PR_CreateAlarm(void); ** INPUTS: PRAlarm* ** OUTPUTS: None ** RETURN: PRStatus -** +** ** SIDE EFFECTS: ** This destroys the context that was created by PR_CreateAlarm(). ** If there are any active alarms (PRAlarmID), they will be cancelled. ** Once that is done, the thread that was used to deliver the alarms -** will be joined. +** will be joined. ** RESTRICTIONS: -** None. +** None. ** MEMORY: N/A ** ALGORITHM: N/A ***********************************************************************/ @@ -105,7 +105,7 @@ NSPR_API(PRStatus) PR_DestroyAlarm(PRAlarm *alarm); ** OUTPUTS: None ** RETURN: PRAlarmID* Handle to the notifier just created ** or NULL if the request failed. -** +** ** SIDE EFFECTS: ** A periodic notifier is created. The notifications will be delivered ** by the alarm's internal thread at a fixed interval whose rate is the @@ -114,7 +114,7 @@ NSPR_API(PRStatus) PR_DestroyAlarm(PRAlarm *alarm); ** the notifier routine indicates that they should cease of the alarm ** context is destroyed (PR_DestroyAlarm). ** RESTRICTIONS: -** None. +** None. ** MEMORY: Memory for the notifier object. ** ALGORITHM: The rate at which notifications are delivered are stated ** to be "'rate' notifies per 'interval'". The exact time of @@ -124,7 +124,7 @@ NSPR_API(PRStatus) PR_DestroyAlarm(PRAlarm *alarm); ** notification sequence number. Such notifications have the ** potential to be late by not more than 'interval'/'rate'. ** The amount of lateness of one notification is taken into -** account on the next in an attempt to avoid long term slew. +** account on the next in an attempt to avoid long term slew. ***********************************************************************/ NSPR_API(PRAlarmID*) PR_SetAlarm( PRAlarm *alarm, PRIntervalTime period, PRUint32 rate, @@ -141,7 +141,7 @@ NSPR_API(PRAlarmID*) PR_SetAlarm( ** the notifies will be delivered. ** OUTPUTS: None ** RETURN: PRStatus Indication of completion. -** +** ** SIDE EFFECTS: ** An existing alarm may have its period and rate redefined. The ** additional side effect is that the notifier's epoch is recomputed. @@ -150,10 +150,10 @@ NSPR_API(PRAlarmID*) PR_SetAlarm( ** RESTRICTIONS: ** This function may only be called in the notifier for that alarm. ** MEMORY: N/A. -** ALGORITHM: See PR_SetAlarm(). +** ALGORITHM: See PR_SetAlarm(). ***********************************************************************/ NSPR_API(PRStatus) PR_ResetAlarm( - PRAlarmID *id, PRIntervalTime period, PRUint32 rate); + PRAlarmID *id, PRIntervalTime period, PRUint32 rate); PR_END_EXTERN_C diff --git a/nsprpub/pr/include/obsolete/probslet.h b/nsprpub/pr/include/obsolete/probslet.h index 2eff0ba414..db743c5ed1 100644 --- a/nsprpub/pr/include/obsolete/probslet.h +++ b/nsprpub/pr/include/obsolete/probslet.h @@ -48,51 +48,51 @@ typedef struct PR_fd_set { ** DESCRIPTION: ** ** 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 +** 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. ** ** INPUTS: -** PRInt32 num +** 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. -** +** condition is of interest. +** ** PR_fd_set *writefds ** A set describing the io descriptors for which ready for writing -** condition is of interest. -** +** condition is of interest. +** ** PR_fd_set *exceptfds ** A set describing the io descriptors for which exception pending -** condition is of interest. +** 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. ** -** 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. +** 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. ** -** OUTPUTS: +** OUTPUTS: ** 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. ** ** RETURN:PRInt32 ** 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 +** 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? ************************************************************************** @@ -101,21 +101,21 @@ 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 +** 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 +** 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. */ diff --git a/nsprpub/pr/include/obsolete/protypes.h b/nsprpub/pr/include/obsolete/protypes.h index 2275bce0dd..5400afb234 100644 --- a/nsprpub/pr/include/obsolete/protypes.h +++ b/nsprpub/pr/include/obsolete/protypes.h @@ -28,14 +28,6 @@ typedef PRIntn intn; */ /* - * BeOS defines all the int types below in its standard header - * file SupportDefs.h. - */ -#ifdef XP_BEOS -#include <support/SupportDefs.h> -#endif - -/* * SVR4 typedef of uint is commonly found on UNIX machines. * * On AIX 4.3, sys/inttypes.h (which is included by sys/types.h) @@ -56,7 +48,7 @@ typedef PRIntn intn; * uint */ -#if !defined(XP_BEOS) && !defined(XP_OS2) && !defined(XP_UNIX) || defined(NTO) +#if !defined(XP_OS2) && !defined(XP_UNIX) || defined(NTO) typedef PRUintn uint; #endif @@ -64,43 +56,35 @@ typedef PRUintn uint; * uint64 */ -#if !defined(XP_BEOS) typedef PRUint64 uint64; -#endif /* * uint32 */ -#if !defined(XP_BEOS) #if !defined(_WIN32) && !defined(XP_OS2) && !defined(NTO) typedef PRUint32 uint32; #else typedef unsigned long uint32; #endif -#endif /* * uint16 */ -#if !defined(XP_BEOS) typedef PRUint16 uint16; -#endif /* * uint8 */ -#if !defined(XP_BEOS) typedef PRUint8 uint8; -#endif /* * int64 */ -#if !defined(XP_BEOS) && !defined(_PR_AIX_HAVE_BSD_INT_TYPES) +#if !defined(_PR_AIX_HAVE_BSD_INT_TYPES) typedef PRInt64 int64; #endif @@ -108,7 +92,7 @@ typedef PRInt64 int64; * int32 */ -#if !defined(XP_BEOS) && !defined(_PR_AIX_HAVE_BSD_INT_TYPES) \ +#if !defined(_PR_AIX_HAVE_BSD_INT_TYPES) \ && !defined(HPUX) #if !defined(_WIN32) && !defined(XP_OS2) && !defined(NTO) typedef PRInt32 int32; @@ -121,7 +105,7 @@ typedef long int32; * int16 */ -#if !defined(XP_BEOS) && !defined(_PR_AIX_HAVE_BSD_INT_TYPES) \ +#if !defined(_PR_AIX_HAVE_BSD_INT_TYPES) \ && !defined(HPUX) typedef PRInt16 int16; #endif @@ -130,7 +114,7 @@ typedef PRInt16 int16; * int8 */ -#if !defined(XP_BEOS) && !defined(_PR_AIX_HAVE_BSD_INT_TYPES) \ +#if !defined(_PR_AIX_HAVE_BSD_INT_TYPES) \ && !defined(HPUX) typedef PRInt8 int8; #endif @@ -142,9 +126,9 @@ typedef PRWord prword_t; /* Re: prbit.h */ -#define TEST_BIT PR_TEST_BIT -#define SET_BIT PR_SET_BIT -#define CLEAR_BIT PR_CLEAR_BIT +#define TEST_BIT PR_TEST_BIT +#define SET_BIT PR_SET_BIT +#define CLEAR_BIT PR_CLEAR_BIT /* Re: prarena.h->plarena.h */ #define PRArena PLArena diff --git a/nsprpub/pr/include/obsolete/prsem.h b/nsprpub/pr/include/obsolete/prsem.h index ee313cb2f5..d1981d2b9b 100644 --- a/nsprpub/pr/include/obsolete/prsem.h +++ b/nsprpub/pr/include/obsolete/prsem.h @@ -7,8 +7,8 @@ #define prsem_h___ /* -** API for counting semaphores. Semaphores are counting synchronizing -** variables based on a lock and a condition variable. They are lightweight +** API for counting semaphores. Semaphores are counting synchronizing +** variables based on a lock and a condition variable. They are lightweight ** contention control for a given count of resources. */ #include "prtypes.h" @@ -30,23 +30,23 @@ NSPR_API(void) PR_DestroySem(PRSemaphore *sem); /* ** Wait on a Semaphore. -** -** This routine allows a calling thread to wait or proceed depending upon the -** state of the semahore sem. The thread can proceed only if the counter value -** of the semaphore sem is currently greater than 0. If the value of semaphore -** sem is positive, it is decremented by one and the routine returns immediately -** allowing the calling thread to continue. If the value of semaphore sem is 0, -** the calling thread blocks awaiting the semaphore to be released by another +** +** This routine allows a calling thread to wait or proceed depending upon the +** state of the semahore sem. The thread can proceed only if the counter value +** of the semaphore sem is currently greater than 0. If the value of semaphore +** sem is positive, it is decremented by one and the routine returns immediately +** allowing the calling thread to continue. If the value of semaphore sem is 0, +** the calling thread blocks awaiting the semaphore to be released by another ** thread. -** -** This routine can return PR_PENDING_INTERRUPT if the waiting thread +** +** This routine can return PR_PENDING_INTERRUPT if the waiting thread ** has been interrupted. */ NSPR_API(PRStatus) PR_WaitSem(PRSemaphore *sem); /* -** This routine increments the counter value of the semaphore. If other threads -** are blocked for the semaphore, then the scheduler will determine which ONE +** This routine increments the counter value of the semaphore. If other threads +** are blocked for the semaphore, then the scheduler will determine which ONE ** thread will be unblocked. */ NSPR_API(void) PR_PostSem(PRSemaphore *sem); |