зеркало из https://github.com/mozilla/gecko-dev.git
Bug 1753127 - NSPR doc: fix the typos, warnings and nbsp; r=kaie
Depends on D137612 Differential Revision: https://phabricator.services.mozilla.com/D137650
This commit is contained in:
Родитель
16b9c75459
Коммит
14e205a735
|
@ -7,8 +7,6 @@ thread synchronization, normal file and network I/O, interval timing and
|
|||
calendar time, basic memory management (malloc and free) and shared
|
||||
library linking.
|
||||
|
||||
.. _History:
|
||||
|
||||
History
|
||||
~~~~~~~
|
||||
|
||||
|
@ -43,8 +41,6 @@ denominator*, but to exploit the best features of each operating system
|
|||
on which it runs, and still provide a uniform service across a wide
|
||||
range of host offerings.
|
||||
|
||||
.. _Threads:
|
||||
|
||||
Threads
|
||||
^^^^^^^
|
||||
|
||||
|
@ -100,8 +96,6 @@ IPv6. To that end it is possible to perform translations of ASCII
|
|||
strings (DNS names) into NSPR's network address structures, with no
|
||||
regard to whether the addressing technology is IPv4 or IPv6.
|
||||
|
||||
.. _Time:
|
||||
|
||||
Time
|
||||
^^^^
|
||||
|
||||
|
@ -141,8 +135,6 @@ functions. Depending on the platform, the functions may be implemented
|
|||
almost entirely in the NSPR runtime or simply shims that call
|
||||
immediately into the host operating system's offerings.
|
||||
|
||||
.. _Linking:
|
||||
|
||||
Linking
|
||||
^^^^^^^
|
||||
|
||||
|
@ -150,8 +142,6 @@ Support for linking (shared library loading and unloading) is part of
|
|||
NSPR's feature set. In most cases this is simply a smoothing over of the
|
||||
facilities offered by the various platform providers.
|
||||
|
||||
.. _Where_It.27s_Headed:
|
||||
|
||||
Where It's Headed
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
|
@ -11,8 +11,6 @@ below to run Firefox with cookie logging enabled.
|
|||
Enabling Cookie Logging
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. _Windows:
|
||||
|
||||
Windows
|
||||
^^^^^^^
|
||||
|
||||
|
@ -25,8 +23,6 @@ normal installations of Windows).
|
|||
#. Type "set NSPR_LOG_MODULES=cookie:4" and press Enter
|
||||
#. Run Firefox by typing "firefox.exe" and pressing Enter.
|
||||
|
||||
.. _Linux:
|
||||
|
||||
Linux
|
||||
^^^^^
|
||||
|
||||
|
@ -39,8 +35,6 @@ already).
|
|||
#. Type "export NSPR_LOG_MODULES=cookie:4" and press Enter.
|
||||
#. Run Firefox by typing "./firefox" and pressing Enter
|
||||
|
||||
.. _Mac_OS_X:
|
||||
|
||||
Mac OS X
|
||||
^^^^^^^^
|
||||
|
||||
|
@ -57,8 +51,6 @@ modify these instructions already).
|
|||
#. Run Firefox by typing "./firefox-bin" and pressing Return (note that
|
||||
Firefox will launch behind windows for other applications).
|
||||
|
||||
.. _Creating_the_Log:
|
||||
|
||||
Creating the Log
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
|
@ -6,8 +6,6 @@ system level and libc-like functions. The API is used in the Mozilla
|
|||
clients, many of Red Hat's and Oracle's server applications, and other
|
||||
software offerings.
|
||||
|
||||
.. _Documentation:
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
|
@ -48,8 +46,6 @@ your platform:
|
|||
build symbols) for package *mozilla-nspr-32bit*
|
||||
- *mozilla-nspr-debugsource* : Debug sources for all of the above
|
||||
|
||||
.. _Community:
|
||||
|
||||
Community
|
||||
---------
|
||||
|
||||
|
|
|
@ -129,8 +129,6 @@ native file descriptors (socket handles) cannot be added to
|
|||
<tt>PR_fd_set</tt>, i.e., the functions <tt>PR_FD_NSET</tt>,
|
||||
<tt>PR_FD_NCLR</tt>, <tt>PR_FD_NISSET</tt> do not work.
|
||||
|
||||
.. _PR_Available():
|
||||
|
||||
PR_Available()
|
||||
--------------
|
||||
|
||||
|
|
|
@ -9,8 +9,6 @@ utility suite such as MKS Toolkit, Cygwin, and MSYS. The easiest way to
|
|||
get these tools is to install the
|
||||
:ref:`MozillaBuild` package.
|
||||
|
||||
.. _Introduction:
|
||||
|
||||
Introduction
|
||||
~~~~~~~~~~~~
|
||||
|
||||
|
@ -66,8 +64,6 @@ Specify these two options to generate an optimized (release) build.
|
|||
These two options can actually be used independently, but it's not
|
||||
recommended.
|
||||
|
||||
.. _--enable-64bit:
|
||||
|
||||
--enable-64bit
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
|
|
|
@ -13,13 +13,9 @@ NSPR contributor guide
|
|||
should help the contributor in crafting his contribution, increasing
|
||||
its likelihood for acceptance.
|
||||
|
||||
.. _General_Guidelines:
|
||||
|
||||
General Guidelines
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. _Downward_Compatibility:
|
||||
|
||||
*Downward Compatibility*
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
@ -30,16 +26,12 @@ NSPR cannot change. Should you need to have a similar API, with some
|
|||
slightly different behavior or different function prototype, then
|
||||
suggest a new API with a different name.
|
||||
|
||||
.. _C_Language_API:
|
||||
|
||||
*C Language API*
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
The NSPR API is a C Language API. Please do not contribute Java, C or
|
||||
other language wrappers.
|
||||
|
||||
.. _Coding_Style:
|
||||
|
||||
*Coding Style*
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
|
@ -48,8 +40,6 @@ code. Make yours look like that. Some guidelines concerning naming
|
|||
conventions can be found in :ref:`NSPR_Naming_Conventions`.
|
||||
in the :ref:`NSPR API Reference`.
|
||||
|
||||
.. _Ownership_of_your_contribution:
|
||||
|
||||
*Ownership of your contribution*
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
@ -61,16 +51,12 @@ pay close attention to the rights of your "Day-Job" employer. If you
|
|||
snatched it from somewhere else, tell us where; show us where the right
|
||||
to incorporate it into NSPR exists.
|
||||
|
||||
.. _License_under_MPL_or_GPL:
|
||||
|
||||
*License under MPL or GPL*
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When you contribute material to NSPR, you agree to allow your
|
||||
contribution to be licensed under the MPL or GPL.
|
||||
|
||||
.. _BugFixes:
|
||||
|
||||
BugFixes
|
||||
~~~~~~~~
|
||||
|
||||
|
@ -82,8 +68,6 @@ Include your changes as diffs in an attachment to the BugZilla report.
|
|||
|
||||
Use a coding style consistent with the source file you are changing.
|
||||
|
||||
.. _New_Features:
|
||||
|
||||
New Features
|
||||
~~~~~~~~~~~~
|
||||
|
||||
|
@ -123,7 +107,7 @@ See:
|
|||
`prshm.h <http://lxr.mozilla.org/nspr/source/nsprpub/pr/include/prshm.h>`__
|
||||
as an example of how your header file(s) should be documented.
|
||||
|
||||
**Source File Descriptions**. Provide descriptive documentation in your
|
||||
*Source File Descriptions*o. Provide descriptive documentation in your
|
||||
source (*.c) files. Alas, we have no source files documented as we think
|
||||
they should be.
|
||||
|
||||
|
@ -135,15 +119,13 @@ features:
|
|||
- You must provide test cases that test all APIs you are adding. See:
|
||||
[#TestCases Test Cases]
|
||||
|
||||
.. _New_Libraries:
|
||||
|
||||
New Libraries
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
All the guidelines applicable to [#NewFeatures New Features] applies to
|
||||
new libraries.
|
||||
|
||||
For purposes of this paper, a "new library" is defined as a libary under
|
||||
For purposes of this paper, a "new library" is defined as a library under
|
||||
the ``mozilla/nsprpub/lib`` directory tree and built as a separate
|
||||
library. These libraries exist, for the most part, as "legacy" code from
|
||||
NSPR 1.0. [Note that the current NSPR module owners do not now nor never
|
||||
|
@ -157,8 +139,6 @@ applications using NSPR, such as ``...nsprpub/lib/libc/plgetopt.*.``
|
|||
- May rely on the NSPR API
|
||||
- May NOT rely on any other library API
|
||||
|
||||
.. _New_Platform_Ports:
|
||||
|
||||
New Platform Ports
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
@ -167,8 +147,6 @@ New Platform Ports
|
|||
- platform specific code in ``pr/src/md/platform/*.c``
|
||||
- make rules in ``config/_platform.mk``
|
||||
|
||||
.. _Documentation:
|
||||
|
||||
Documentation
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
|
@ -178,8 +156,6 @@ word processing system [don't ask]. Document your work as described in
|
|||
We will see that your documentation is transcribed into the appropriate
|
||||
word processor and the derived HTML shows up on mozilla.org
|
||||
|
||||
.. _Test_Cases:
|
||||
|
||||
Test Cases
|
||||
~~~~~~~~~~
|
||||
|
||||
|
@ -191,15 +167,13 @@ existing test case did not catch a bug it should have caught.
|
|||
The new test cases should be implemented in the style of other NSPR test
|
||||
cases.
|
||||
|
||||
Test cases should prove that the added API items work as advertized.
|
||||
Test cases should prove that the added API items work as advertised.
|
||||
|
||||
Test cases should serve as an example of how to use the API items.
|
||||
|
||||
Test cases should provoke failure of every API item and report its
|
||||
failure.
|
||||
|
||||
.. _Frequently_Asked_Questions_(FAQ):
|
||||
|
||||
Frequently Asked Questions (FAQ)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
|
@ -11,8 +11,6 @@ certainly surface.
|
|||
|
||||
*This memo is by no way complete.*
|
||||
|
||||
.. _Multiplatform:
|
||||
|
||||
Multiplatform
|
||||
-------------
|
||||
|
||||
|
|
|
@ -17,7 +17,7 @@ type. The anonymous file-mapped shared memory provides an inheritable
|
|||
shared memory, as in: the child process inherits the shared memory.
|
||||
Compare the file-mapped anonymous shared memory to to a named shared
|
||||
memory described in prshm.h. The intent is to provide a shared memory
|
||||
that is accessbile only by parent and child processes. ... It's a
|
||||
that is accessible only by parent and child processes. ... It's a
|
||||
security thing.
|
||||
|
||||
Depending on the underlying platform, the file-mapped shared memory may
|
||||
|
|
|
@ -7,8 +7,6 @@ monitor for all objects. A hash table is used to quickly map addresses
|
|||
to their respective monitors. The system automatically enlarges the hash
|
||||
table as needed.
|
||||
|
||||
.. _Important:
|
||||
|
||||
Important
|
||||
---------
|
||||
|
||||
|
|
|
@ -72,8 +72,6 @@ functions of this type are provided by NSPR:
|
|||
- :ref:`PRTimeParamFn`
|
||||
- :ref:`PR_LocalTimeParameters` and :ref:`PR_GMTParameters`
|
||||
|
||||
.. _Functions:
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
|
||||
Dynamic Library Search Path
|
||||
===========================
|
||||
Dynamic Library Search
|
||||
======================
|
||||
|
||||
This section describes NSPR's programming interface to load, unload and
|
||||
resolve symbols in dynamic libraries. It also provides a method by which
|
||||
|
@ -75,10 +74,8 @@ for Win32.
|
|||
- `Exporting Symbols from the Main Executable
|
||||
Program <#Exporting_Symbols_from_the_Main_Executable_Program>`__
|
||||
|
||||
.. _Dynamic_Library_Search_Path:
|
||||
|
||||
Dynamic Library Search Path
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The dynamic library search path is the list of directories in which to
|
||||
look for a dynamic library. Each platform has its own standard
|
||||
|
|
|
@ -12,8 +12,6 @@ are:
|
|||
- :ref:`PR_dtoa`
|
||||
- :ref:`PR_cnvtf`
|
||||
|
||||
.. _References:
|
||||
|
||||
References
|
||||
----------
|
||||
|
||||
|
|
|
@ -188,7 +188,7 @@ or unset.
|
|||
- :ref:`PR_WaitForPollableEvent`
|
||||
|
||||
One can call :ref:`PR_Poll` with the :ref:`PR_POLL_READ` flag on a pollable
|
||||
event. Whe the pollable event is set, :ref:`PR_Poll` returns the the
|
||||
event. When the pollable event is set, :ref:`PR_Poll` returns the the
|
||||
:ref:`PR_POLL_READ` flag set in the out_flags.
|
||||
|
||||
.. _Manipulating_Layers:
|
||||
|
|
|
@ -22,8 +22,6 @@ NSPR API Reference
|
|||
|
||||
- :ref:`NSPR_Sample_Code`
|
||||
|
||||
.. _NSPR_Types:
|
||||
|
||||
:ref:`NSPR_Types`
|
||||
-----------------
|
||||
|
||||
|
|
|
@ -155,15 +155,15 @@ scheduling algorithm to find the most appropriate thread. The chosen
|
|||
thread may be of higher priority, of the same priority, or even the same
|
||||
thread. It will not be a thread of lower priority.
|
||||
|
||||
Some operating systems cannot be made preemptable (for example, Mac OS
|
||||
Some operating systems cannot be made preemptible (for example, Mac OS
|
||||
and Win 16). This puts them at some risk in supporting arbitrary code,
|
||||
even if the code is interpreted (Java). Other systems are not
|
||||
thread-aware, and their runtime libraries not thread-safe (most versions
|
||||
of Unix). These systems can support local level thread abstractions that
|
||||
can be made preemptable, but run the risk of library corruption
|
||||
can be made preemptible, but run the risk of library corruption
|
||||
(``libc``). Still other operating systems have a native notion of
|
||||
threads, and their libraries are thread-aware and support locking.
|
||||
However, if local threads are also present, and they are preemptable,
|
||||
However, if local threads are also present, and they are preemptible,
|
||||
they are subject to deadlock. At this time, the only safe solutions are
|
||||
to turn off preemption (a runtime decision) or to preempt global threads
|
||||
only.
|
||||
|
@ -173,7 +173,7 @@ only.
|
|||
Interrupting Threads
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
NSPR threads are interruptable, with some constraints and
|
||||
NSPR threads are interruptible, with some constraints and
|
||||
inconsistencies.
|
||||
|
||||
To interrupt a thread, the caller of :ref:`PR_Interrupt` must have the NSPR
|
||||
|
|
|
@ -105,10 +105,10 @@ debugging aids.
|
|||
myLM = PR_NewLogModule( "userStuff" );
|
||||
PR_ASSERT( myLM );
|
||||
|
||||
PR_LOG( myLM, PR_LOG_NOTICE, ("Log a Notice %d\n", 999 ));
|
||||
for (i = 0; i < 10 ; i++ )
|
||||
PR_LOG( myLM, PR_LOG_NOTICE, ("Log a Notice %d\n", 999 ));
|
||||
for (i = 0; i < 10 ; i++ )
|
||||
{
|
||||
PR_LOG( myLM, PR_LOG_DEBUG, ("Log Debug number: %d\n", i));
|
||||
PR_LOG( myLM, PR_LOG_DEBUG, ("Log Debug number: %d\n", i));
|
||||
PR_Sleep( 500 );
|
||||
}
|
||||
PR_LOG( myLM, PR_LOG_NOTICE, "That's all folks\n");
|
||||
|
|
|
@ -40,8 +40,6 @@ and cannot be reused.
|
|||
After you call :ref:`PR_DeleteSharedMemory`, any further use of the shared
|
||||
memory associated with the name may cause unpredictable results.
|
||||
|
||||
.. _Filenames:
|
||||
|
||||
Filenames
|
||||
~~~~~~~~~
|
||||
|
||||
|
|
|
@ -53,7 +53,7 @@ Converting between a string and a network address
|
|||
- :ref:`PR_StringToNetAddr`
|
||||
- :ref:`PR_NetAddrToString`
|
||||
|
||||
.. _Getting_Host_Names_and_Addresses:
|
||||
.. _Converting_address_formats:
|
||||
|
||||
Converting address formats
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
|
@ -4,7 +4,6 @@ NSPR_LOG_FILE
|
|||
This environment variable specifies the file to which log messages are
|
||||
directed.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -13,16 +12,15 @@ Syntax
|
|||
|
||||
filespec
|
||||
|
||||
*filespec* is a filename. The exact syntax is platform specific.
|
||||
*filespec* is a filename. The exact syntax is platform specific.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Use this environment variable to specify a log file other than the
|
||||
default. If :ref:`NSPR_LOG_FILE` is not in the environment, then log output
|
||||
is written to ``stdout`` or ``stderr``, depending on the platform. Set
|
||||
is written to ``stdout`` or ``stderr``, depending on the platform. Set
|
||||
:ref:`NSPR_LOG_FILE` to the name of the log file you want to use. NSPR
|
||||
logging, when enabled, writes to the file named in this environment
|
||||
variable.
|
||||
|
|
|
@ -4,7 +4,6 @@ NSPR_LOG_MODULES
|
|||
This environment variable specifies which log modules have logging
|
||||
enabled.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -27,7 +26,6 @@ following meanings:
|
|||
- 4 = PR_LOG_DEBUG: debug messages, notices
|
||||
- 5: everything!
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -36,12 +34,12 @@ Specify a ``moduleName`` that is associated with the ``name`` argument
|
|||
in a call to
|
||||
`:ref:`PR_NewLogModule` <http://www-archive.mozilla.org/projects/nspr/reference/html/prlog.html#25372>`__
|
||||
and a non-zero ``level`` value to enable logging for the named
|
||||
``moduleName``.
|
||||
``moduleName``.
|
||||
|
||||
Special log module names are provided for controlling NSPR's log service
|
||||
at execution time. These controls should be set in the
|
||||
:ref:`NSPR_LOG_MODULES` environment variable at execution time to affect
|
||||
NSPR's log service for your application.
|
||||
NSPR's log service for your application.
|
||||
|
||||
- **all** The name ``all`` enables all log modules. To enable all log
|
||||
module calls to
|
||||
|
@ -56,19 +54,17 @@ NSPR's log service for your application.
|
|||
form "2015-01-15 21:24:26.049906 UTC - " prefixing every logged line.
|
||||
|
||||
- **append** Including ``append`` results in log entries being appended
|
||||
to the existing contents of the file referenced by NSPR_LOG_FILE. If
|
||||
to the existing contents of the file referenced by NSPR_LOG_FILE. If
|
||||
not specified, the existing contents of NSPR_LOG_FILE will be lost as
|
||||
a new file is created with the same filename.
|
||||
|
||||
- **sync** The name ``sync`` enables unbuffered logging. This ensures
|
||||
- **sync** The name ``sync`` enables unbuffered logging. This ensures
|
||||
that all log messages are flushed to the operating system as they are
|
||||
written, but may slow the program down.
|
||||
|
||||
- **bufsize:size** The name ``bufsize:``\ *size* sets the log buffer to
|
||||
*size*.
|
||||
|
||||
.. _Examples:
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_CompareStrings
|
|||
|
||||
Compares two character strings.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
const void *v1,
|
||||
const void *v2);
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_CompareValues
|
|||
|
||||
Compares two ``void *`` values numerically.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
void *v1,
|
||||
const void *v2);
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_HashString
|
|||
|
||||
A general-purpose hash function for character strings.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PLHashNumber PL_HashString(const void *key);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,14 +22,12 @@ The function has the following parameter:
|
|||
``key``
|
||||
A pointer to a character string.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
The hash number for the specified key.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_HashTableAdd
|
|||
|
||||
Add a new entry with the specified key and value to the hash table.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
const void *key,
|
||||
void *value);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -31,14 +29,12 @@ The function has the following parameters:
|
|||
``value``
|
||||
A pointer to the value for the entry to be added.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
A pointer to the new entry.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_HashTableDestroy
|
|||
|
||||
Frees the table and all the entries.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
void PL_HashTableDestroy(PLHashTable *ht);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,7 +22,6 @@ The function has the following parameter:
|
|||
``ht``
|
||||
A pointer to the hash table to be destroyed.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -4,7 +4,6 @@ PL_HashTableEnumerateEntries
|
|||
Enumerates all the entries in the hash table, invoking a specified
|
||||
function on each entry.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -18,7 +17,6 @@ Syntax
|
|||
PLHashEnumerator f,
|
||||
void *arg);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -32,14 +30,12 @@ The function has the following parameters:
|
|||
``arg``
|
||||
Argument for function ``f``.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
The number of entries enumerated.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_HashTableLookup
|
|||
|
||||
Looks up the entry with the specified key and return its value.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
PLHashTable *ht,
|
||||
const void *key);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -29,7 +27,6 @@ The function has the following parameters:
|
|||
``key``
|
||||
A pointer to the key for the entry to look up.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -37,7 +34,6 @@ Returns
|
|||
The value of the entry with the specified key, or ``NULL`` if there is
|
||||
no such entry.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_HashTableRemove
|
|||
|
||||
Removes the entry with the specified key from the hash table.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
PLHashTable *ht,
|
||||
const void *key);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -28,7 +26,6 @@ The function has the following parameters:
|
|||
``key``
|
||||
A pointer to the key for the entry to be removed.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -42,7 +39,6 @@ returns ``PR_TRUE``.
|
|||
If the table is underloaded, :ref:`PL_HashTableRemove` also shrinks the
|
||||
number of buckets by half.
|
||||
|
||||
.. _Remark:
|
||||
|
||||
Remark
|
||||
------
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_NewHashTable
|
|||
|
||||
Create a new hash table.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -21,7 +20,6 @@ Syntax
|
|||
void *allocPriv
|
||||
);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -42,14 +40,12 @@ The function has the following parameters:
|
|||
``allocPriv``
|
||||
Passed as the first argument (pool).
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
The new hash table.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -5,7 +5,6 @@ PL_strcpy
|
|||
Copies a string, up to and including the trailing ``'\0'``, into a
|
||||
destination buffer.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
~~~~~~
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
char * PL_strcpy(char *dest, const char *src);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -27,7 +25,6 @@ The function has these parameters:
|
|||
``src``
|
||||
Pointer to the string to be copied.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -35,7 +32,6 @@ Returns
|
|||
The function returns a pointer to the buffer specified by the ``dest``
|
||||
parameter.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
@ -4,7 +4,6 @@ PL_strdup
|
|||
Returns a pointer to a new memory node in the NSPR heap containing a
|
||||
copy of a specified string.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
~~~~~~
|
||||
|
@ -15,7 +14,6 @@ Syntax
|
|||
|
||||
char *PL_strdup(const char *s);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -25,7 +23,6 @@ The function has a single parameter:
|
|||
``s``
|
||||
The string to copy, may be ``NULL``.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -35,7 +32,6 @@ The function returns one of these values:
|
|||
- If successful, a pointer to a copy of the specified string.
|
||||
- If the memory allocation fails, ``NULL``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
@ -45,8 +41,6 @@ greater than the length of the string being copied. A ``NULL`` argument,
|
|||
like a zero-length argument, results in a pointer to a one-byte block of
|
||||
memory containing the null value.
|
||||
|
||||
.. _Notes:
|
||||
|
||||
Notes
|
||||
~~~~~
|
||||
|
||||
|
|
|
@ -3,7 +3,6 @@ PL_strfree
|
|||
|
||||
Frees memory allocated by :ref:`PL_strdup`
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
~~~~~~
|
||||
|
@ -12,7 +11,6 @@ Syntax
|
|||
|
||||
void PL_strfree(char *s);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
|
|
@ -4,7 +4,6 @@ PL_strlen
|
|||
Returns the length of a specified string (not including the trailing
|
||||
``'\0'``)
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
~~~~~~
|
||||
|
@ -13,7 +12,6 @@ Syntax
|
|||
|
||||
PRUint32 PL_strlen(const char *str);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -23,7 +21,6 @@ The function has these parameter:
|
|||
``str``
|
||||
Size in bytes of item to be allocated.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
#define HT_FREE_VALUE 0 /* just free the entry's value */
|
||||
#define HT_FREE_ENTRY 1 /* free value and entire entry */
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -34,7 +32,6 @@ to a memory pool used by the memory allocator.
|
|||
The ``freeEntry`` function does not need to free the value of the entry.
|
||||
If flag is ``HT_FREE_ENTRY``, the function frees the entry.
|
||||
|
||||
.. _Remark:
|
||||
|
||||
Remark
|
||||
------
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
PLHashComparator
|
||||
================
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
const void *v1,
|
||||
const void *v2);
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -29,7 +27,6 @@ For convenience, two comparator functions are provided.
|
|||
:ref:`PL_CompareValues` compares the values of the arguments v1 and v2
|
||||
numerically.
|
||||
|
||||
.. _Remark:
|
||||
|
||||
Remark
|
||||
------
|
||||
|
@ -37,7 +34,6 @@ Remark
|
|||
The return value of :ref:`PLHashComparator` functions should be of type
|
||||
:ref:`PRBool`.
|
||||
|
||||
.. _See_Also:
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -9,7 +8,6 @@ Syntax
|
|||
|
||||
typedef struct PLHashEntry PLHashEntry;
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -15,7 +14,6 @@ Syntax
|
|||
#define HT_ENUMERATE_REMOVE 2 /* remove and free the current entry */
|
||||
#define HT_ENUMERATE_UNHASH 4 /* just unhash the current entry */
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -26,7 +24,6 @@ to a user-specified function of type ``PLHashEnumerator`` with the hash
|
|||
table entry, an integer index, and an arbitrary piece of user data as
|
||||
argument.
|
||||
|
||||
.. _Remark:
|
||||
|
||||
Remark
|
||||
------
|
||||
|
@ -37,7 +34,6 @@ The entries are unlinked from the table, they are not freed, but the
|
|||
entry count (the ``nentries`` field of the ``PLHashTable`` structure) is
|
||||
not decremented.
|
||||
|
||||
.. _See_Also:
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -9,7 +8,6 @@ Syntax
|
|||
|
||||
typedef PLHashNumber (PR_CALLBACK *PLHashFunction)(const void *key);
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -17,7 +15,6 @@ Description
|
|||
``PLHashNumber`` is a function type that maps the key of a hash table
|
||||
entry to a hash number.
|
||||
|
||||
.. _See_Also:
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -11,7 +10,6 @@ Syntax
|
|||
|
||||
#define PL_HASH_BITS 32
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -24,7 +22,6 @@ bucket.
|
|||
The macro ``PL_HASH_BITS`` is the size (in bits) of the ``PLHashNumber``
|
||||
data type and has the value of 32.
|
||||
|
||||
.. _See_Also:
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -9,7 +8,6 @@ Syntax
|
|||
|
||||
typedef struct PLHashTable PLHashTable;
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_Abort
|
|||
|
||||
Aborts the process in a nongraceful manner.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
void PR_Abort(void);
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_Accept
|
|||
|
||||
Accepts a connection on a specified socket.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
PRNetAddr *addr,
|
||||
PRIntervalTime timeout);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -34,7 +32,6 @@ The function has the following parameters:
|
|||
A value of type :ref:`PRIntervalTime` specifying the time limit for
|
||||
completion of the accept operation.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -46,7 +43,6 @@ The function returns one of the following values:
|
|||
- If unsuccessful, ``NULL``. Further information can be obtained by
|
||||
calling :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_AcceptRead
|
|||
|
||||
Accepts a new connection and receives a block of data.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -20,7 +19,6 @@ Syntax
|
|||
PRInt32 amount,
|
||||
PRIntervalTime timeout);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -57,7 +55,6 @@ The function has the following parameters:
|
|||
is accepted; the read will time out after the timeout interval
|
||||
elapses.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -66,7 +63,6 @@ Returns
|
|||
- The value -1 indicates a failure. The reason for the failure can be
|
||||
obtained by calling :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_Access
|
|||
|
||||
Determines the accessibility of a file.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
const char *name,
|
||||
PRAccessHow how);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -33,7 +31,6 @@ The function has the following parameters:
|
|||
- :ref:`PR_ACCESS_WRITE_OK`. Test for write permission.
|
||||
- :ref:`PR_ACCESS_EXISTS`. Check existence of file.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_APPEND_LINK
|
|||
|
||||
Appends an element to the end of a list.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
PRCList *elemp,
|
||||
PRCList *listp);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -26,7 +24,6 @@ Parameters
|
|||
``listp``
|
||||
A pointer to the list.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_ASSERT
|
|||
|
||||
Terminates execution when a given expression is ``FALSE``.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
void PR_ASSERT ( expression );
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -25,14 +23,12 @@ expression
|
|||
Any valid C language expression that evaluates to ``TRUE`` or
|
||||
``FALSE``.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
Nothing
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
PR_AtomicAdd
|
||||
============
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
PRInt32 *ptr,
|
||||
PRInt32 val);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -26,18 +24,16 @@ The function has the following parameters:
|
|||
``val``
|
||||
A value to be added.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
The returned value is the result of the addition.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Atomically add a 32 bit value.
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_AtomicDecrement
|
|||
|
||||
Atomically decrements a 32-bit value.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRInt32 PR_AtomicDecrement(PRInt32 *val);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,14 +22,12 @@ The function has the following parameter:
|
|||
``val``
|
||||
A pointer to the value to decrement.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
The function returns the decremented value (i.e., the result).
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_AtomicIncrement
|
|||
|
||||
Atomically increments a 32-bit value.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRInt32 PR_AtomicIncrement(PRInt32 *val);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,14 +22,12 @@ The function has the following parameter:
|
|||
``val``
|
||||
A pointer to the value to increment.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
The function returns the incremented value (i.e., the result).
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_AtomicSet
|
|||
|
||||
Atomically sets a 32-bit value and return its previous contents.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
PRInt32 *val,
|
||||
PRInt32 newval);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -28,14 +26,12 @@ The function has the following parameter:
|
|||
``newval``
|
||||
The new value to assign to the ``val`` parameter.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
The function returns the prior value of the referenced variable.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_AttachSharedMemory
|
|||
Attaches a memory segment previously opened with :ref:`PR_OpenSharedMemory`
|
||||
and maps it into the process memory space.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -24,7 +23,6 @@ Syntax
|
|||
/* Define values for PR_AttachSharedMemory(...,flags) */
|
||||
#define PR_SHM_READONLY 0x01
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -37,7 +35,6 @@ flags
|
|||
Options for mapping the shared memory. ``PR_SHM_READONLY`` causes the
|
||||
memory to be attached read-only.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -10,7 +10,6 @@ PR_AttachThread
|
|||
|
||||
Associates a :ref:`PRThread` object with an existing native thread.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -24,7 +23,6 @@ Syntax
|
|||
PRThreadPriority priority,
|
||||
PRThreadStack *stack);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -39,7 +37,6 @@ Parameters
|
|||
``stack``
|
||||
The stack for the thread being attached.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -50,7 +47,6 @@ The function returns one of these values:
|
|||
- If unsuccessful, for example if system resources are not available,
|
||||
``NULL``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -5,7 +5,6 @@ Determines the number of bytes (expressed as a 32-bit integer) that are
|
|||
available for reading beyond the current read-write pointer in a
|
||||
specified file or socket.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
|
||||
PRInt32 PR_Available(PRFileDesc *fd);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -26,7 +24,6 @@ The function has the following parameter:
|
|||
``fd``
|
||||
Pointer to a :ref:`PRFileDesc` object representing a file or socket.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -39,7 +36,6 @@ The function returns one of the following values:
|
|||
- If the function fails, it returns the value -1. The error code can
|
||||
then be retrieved via :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -47,7 +43,6 @@ Description
|
|||
:ref:`PR_Available` works on normal files and sockets. :ref:`PR_Available`
|
||||
does not work with pipes on Win32 platforms.
|
||||
|
||||
.. _See_Also:
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
@ -5,7 +5,6 @@ Determines the number of bytes (expressed as a 32-bit integer) that are
|
|||
available for reading beyond the current read-write pointer in a
|
||||
specified file or socket.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
|
||||
PRInt64 PR_Available64(PRFileDesc *fd);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -26,7 +24,6 @@ The function has the following parameter:
|
|||
``fd``
|
||||
Pointer to a :ref:`PRFileDesc` object representing a file or socket.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -39,7 +36,6 @@ The function returns one of the following values:
|
|||
- If the function fails, it returns the value -1. The error code can
|
||||
then be retrieved via :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -47,7 +43,6 @@ Description
|
|||
:ref:`PR_Available64` works on normal files and sockets. :ref:`PR_Available`
|
||||
does not work with pipes on Win32 platforms.
|
||||
|
||||
.. _See_Also:
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_Bind
|
|||
|
||||
Binds an address to a specified socket.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
PRFileDesc *fd,
|
||||
const PRNetAddr *addr);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -29,7 +27,6 @@ The function has the following parameters:
|
|||
A pointer to a :ref:`PRNetAddr` object representing the address to which
|
||||
the socket will be bound.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -40,7 +37,6 @@ The function returns one of the following values:
|
|||
- If unsuccessful, ``PR_FAILURE``. Further information can be obtained
|
||||
by calling :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_BlockClockInterrupts
|
|||
|
||||
Blocks the timer signal used for preemptive scheduling.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_CALLBACKimplementation
|
|||
Used to define pointers to functions that will be implemented by the
|
||||
client but called from a (different) shared library.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -13,7 +12,6 @@ Syntax
|
|||
|
||||
#include <prtypes.h>type PR_CALLBACKimplementation
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_Calloc
|
|||
Allocates zeroed memory from the heap for a number of objects of a given
|
||||
size.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
PRUint32 nelem,
|
||||
PRUint32 elsize);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -27,7 +25,6 @@ Parameters
|
|||
``elsize``
|
||||
The size of an individual element.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -36,7 +33,6 @@ An untyped pointer to the allocated memory, or if the allocation attempt
|
|||
fails, ``NULL``. Call ``PR_GetError()`` to retrieve the error returned
|
||||
by the libc function ``malloc()``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CallOnce
|
|||
|
||||
Ensures that subsystem initialization occurs only once.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
PRCallOnceType *once,
|
||||
PRCallOnceFN func);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CancelJob
|
|||
|
||||
Causes a previously queued job to be canceled.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
NSPR_API(PRStatus) PR_CancelJob(PRJob *job);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -25,7 +23,6 @@ The function has the following parameter:
|
|||
A pointer to a :ref:`PRJob` structure returned by a :ref:`PR_QueueJob`
|
||||
function representing the job to be cancelled.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CEnterMonitor
|
|||
|
||||
Enters the lock associated with a cached monitor.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRMonitor* PR_CEnterMonitor(void *address);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -26,7 +24,6 @@ The function has the following parameter:
|
|||
reference must remain valid as long as there are monitoring
|
||||
operations being performed.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -38,7 +35,6 @@ The function returns one of the following values:
|
|||
- If unsuccessful (the monitor cache needs to be expanded and the
|
||||
system is out of memory), the function returns ``NULL``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CExitMonitor
|
|||
|
||||
Decrement the entry count associated with a cached monitor.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRStatus PR_CExitMonitor(void *address);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -25,7 +23,6 @@ The function has the following parameters:
|
|||
The address of the protected object--the same address previously
|
||||
passed to :ref:`PR_CEnterMonitor`.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -37,7 +34,6 @@ The function returns one of the following values:
|
|||
parameter is invalid or that the calling thread is not in the
|
||||
monitor.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_Cleanup
|
|||
|
||||
Coordinates a graceful shutdown of NSPR.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRStatus PR_Cleanup(void);
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -25,7 +23,6 @@ The function returns one of the following values:
|
|||
- If the calling thread of this function is not the primordial thread,
|
||||
``PR_FAILURE``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_ClearInterrupt
|
|||
|
||||
Clears the interrupt request for the calling thread.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
void PR_ClearInterrupt(void);
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CLIST_IS_EMPTY
|
|||
|
||||
Checks for an empty circular list.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRIntn PR_CLIST_IS_EMPTY (PRCList *listp);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -22,7 +20,6 @@ Parameter
|
|||
``listp``
|
||||
A pointer to the linked list.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_Close
|
|||
|
||||
Closes a file descriptor.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRStatus PR_Close(PRFileDesc *fd);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -24,7 +22,6 @@ The function has the following parameters:
|
|||
``fd``
|
||||
A pointer to a :ref:`PRFileDesc` object.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -34,7 +31,6 @@ One of the following values:
|
|||
- If file descriptor is closed successfully, ``PR_SUCCESS``.
|
||||
- If the file descriptor is not closed successfully, ``PR_FAILURE``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CloseDir
|
|||
|
||||
Closes the specified directory.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRStatus PR_CloseDir(PRDir *dir);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -25,7 +23,6 @@ The function has the following parameter:
|
|||
A pointer to a :ref:`PRDir` structure representing the directory to be
|
||||
closed.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -34,7 +31,6 @@ Returns
|
|||
- If unsuccessful, ``PR_FAILURE``. The reason for the failure can be
|
||||
retrieved via :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -44,7 +40,6 @@ with a call to :ref:`PR_CloseDir` call. Note that after a :ref:`PR_CloseDir`
|
|||
call, any ``PRDirEntry`` object returned by a previous :ref:`PR_ReadDir`
|
||||
call on the same :ref:`PRDir` object becomes invalid.
|
||||
|
||||
.. _See_Also:
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CloseFileMap
|
|||
|
||||
Closes a file mapping.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRStatus PR_CloseFileMap(PRFileMap *fmap);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,7 +22,6 @@ The function has the following parameter:
|
|||
``fmap``
|
||||
The file mapping to be closed.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -35,7 +32,6 @@ The function returns one of the following values:
|
|||
- If the memory region is not successfully unmapped, ``PR_FAILURE``.
|
||||
The error code can be retrieved via :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CloseSemaphore
|
|||
|
||||
Closes a specified semaphore.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
NSPR_API(PRStatus) PR_CloseSemaphore(PRSem *sem);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -25,7 +23,6 @@ The function has the following parameter:
|
|||
A pointer to a ``PRSem`` structure returned from a call to
|
||||
:ref:`PR_OpenSemaphore`.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CloseSharedMemory
|
|||
|
||||
Closes a shared memory segment identified by name.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
PRSharedMemory *shm
|
||||
);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -27,7 +25,6 @@ The function has these parameter:
|
|||
shm
|
||||
The handle returned from :ref:`PR_OpenSharedMemory`.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CNotify
|
|||
|
||||
Notify a thread waiting on a change in the state of monitored data.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
PRStatus PR_CNotify(void *address);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -25,7 +23,6 @@ The function has the following parameter:
|
|||
The address of the monitored object. The calling thread must be in
|
||||
the monitor defined by the value of the address.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -35,7 +32,6 @@ Returns
|
|||
- :ref:`PR_FAILURE` indicates that the monitor has not been entered by the
|
||||
calling thread.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_CNotifyAll
|
|||
Notifies all the threads waiting for a change in the state of monitored
|
||||
data.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -15,7 +14,6 @@ Syntax
|
|||
|
||||
PRStatus PR_CNotifyAll(void *address);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -26,7 +24,6 @@ The function has the following parameter:
|
|||
The address of the monitored object. The calling thread must be in
|
||||
the monitor at the time :ref:`PR_CNotifyAll` is called.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -36,7 +33,6 @@ Returns
|
|||
- :ref:`PR_FAILURE` indicates that the referenced monitor could not be
|
||||
located or that the calling thread was not in the monitor
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_cnvtf
|
|||
|
||||
Converts a floating point number to a string.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -18,7 +17,6 @@ Syntax
|
|||
PRIntn prcsn,
|
||||
PRFloat64 fval);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -35,7 +33,6 @@ The function has these parameters:
|
|||
``fval``
|
||||
The double-precision floating point number to be converted.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_Connect
|
|||
|
||||
Initiates a connection on a specified socket.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
const PRNetAddr *addr,
|
||||
PRIntervalTime timeout);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -33,7 +31,6 @@ The function has the following parameters:
|
|||
A value of type :ref:`PRIntervalTime` specifying the time limit for
|
||||
completion of the connect operation.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -44,7 +41,6 @@ The function returns one of the following values:
|
|||
- If unsuccessful, ``PR_FAILURE``. Further information can be obtained
|
||||
by calling :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
PR_ConnectContinue
|
||||
==================
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
PRFileDesc *fd,
|
||||
PRInt16 out_flags);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -28,7 +26,6 @@ The function has the following parameters:
|
|||
The out_flags field of the poll descriptor returned by
|
||||
`PR_Poll() <PR_Poll>`__.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -36,14 +33,13 @@ Returns
|
|||
- If the nonblocking connect has successfully completed,
|
||||
PR_ConnectContinue returns PR_SUCCESS.
|
||||
- If PR_ConnectContinue() returns PR_FAILURE, call PR_GetError():
|
||||
- PR_IN_PROGRESS_ERROR: the nonblocking connect is still in
|
||||
- PR_IN_PROGRESS_ERROR: the nonblocking connect is still in
|
||||
progress and has not completed yet. The caller should poll the file
|
||||
descriptor for the in_flags PR_POLL_WRITE|PR_POLL_EXCEPT and retry
|
||||
PR_ConnectContinue later when PR_Poll() returns.
|
||||
- Other errors: the nonblocking connect has failed with this
|
||||
- Other errors: the nonblocking connect has failed with this
|
||||
error code.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -56,4 +52,4 @@ on the socket to determine whether the nonblocking connect has completed
|
|||
or is still in progress. Repeat the PR_Poll(), PR_ConnectContinue()
|
||||
sequence until the nonblocking connect has completed.
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_ConvertIPv4AddrToIPv6
|
|||
|
||||
Converts an IPv4 address into an (IPv4-mapped) IPv6 address.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
~~~~~~
|
||||
|
@ -13,11 +12,10 @@ Syntax
|
|||
#include <prnetdb.h>
|
||||
|
||||
void PR_ConvertIPv4AddrToIPv6(
|
||||
PRUint32 v4addr,
|
||||
PRIPv6Addr *v6addr
|
||||
PRUint32 v4addr,
|
||||
PRIPv6Addr *v6addr
|
||||
);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CreateFileMap
|
|||
|
||||
Creates a file mapping object.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
PRInt64 size,
|
||||
PRFileMapProtect prot);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -38,7 +36,6 @@ The function has the following parameters:
|
|||
- :ref:`PR_PROT_WRITECOPY`. Readable, and write is private
|
||||
(copy-on-write).
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -46,7 +43,6 @@ Returns
|
|||
- If successful, a file mapping of type :ref:`PRFileMap`.
|
||||
- If unsuccessful, ``NULL``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CreateIOLayerStub
|
|||
|
||||
Creates a new layer.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
PRDescIdentity ident
|
||||
PRIOMethods const *methods);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -29,14 +27,12 @@ The function has the following parameters:
|
|||
A pointer to the :ref:`PRIOMethods` structure specifying the functions
|
||||
for the new layer.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
A new file descriptor for the specified layer.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_CreatePipe
|
|||
Creates an anonymous pipe and retrieves file descriptors for the read
|
||||
and write ends of the pipe.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
PRFileDesc **readPipe,
|
||||
PRFileDesc **writePipe);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -31,7 +29,6 @@ The function has the following parameters:
|
|||
A pointer to a :ref:`PRFileDesc` pointer. On return, this parameter
|
||||
contains the file descriptor for the write end of the pipe.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -42,7 +39,6 @@ The function returns one of these values:
|
|||
- If the pipe is not successfully created, ``PR_FAILURE``. The error
|
||||
code can be retrieved via :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CreateThread
|
|||
|
||||
Creates a new thread.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -21,7 +20,6 @@ Syntax
|
|||
PRThreadState state,
|
||||
PRUint32 stackSize);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -54,7 +52,6 @@ Parameters
|
|||
parameter, :ref:`PR_CreateThread` chooses the most favorable
|
||||
machine-specific stack size.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -66,7 +63,6 @@ The function returns one of the following values:
|
|||
- If unsuccessful, (for example, if system resources are unavailable),
|
||||
``NULL``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CreateThreadPool
|
|||
|
||||
Create a new hash table.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -19,7 +18,6 @@ Syntax
|
|||
PRUint32 stacksize
|
||||
);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -34,14 +32,12 @@ The function has the following parameters:
|
|||
``stacksize``
|
||||
Size of the stack allocated to each thread in the thread.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
Pointer to a :ref:`PRThreadPool` structure or ``NULL`` on error.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_CWait
|
|||
|
||||
Wait for a notification that a monitor's state has changed.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -16,7 +15,6 @@ Syntax
|
|||
void *address,
|
||||
PRIntervalTime timeout);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -32,7 +30,6 @@ The function has the following parameters:
|
|||
rescheduled. If you specify ``PR_INTERVAL_NO_TIMEOUT``, the function
|
||||
returns if and only if the object is notified.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -46,7 +43,6 @@ The function returns one of the following values:
|
|||
in the cache or that the monitor was located and the calling thread
|
||||
was not the thread that held the monitor's mutex.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
PR_Delete
|
||||
=========
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -12,7 +11,6 @@ Syntax
|
|||
|
||||
PRStatus PR_Delete(const char *name);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -22,7 +20,6 @@ The function has the following parameter:
|
|||
``name``
|
||||
The pathname of the file to be deleted.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -32,7 +29,6 @@ One of the following values:
|
|||
- If file is deleted successfully, ``PR_SUCCESS``.
|
||||
- If the file is not deleted, ``PR_FAILURE``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
@ -41,4 +37,4 @@ Description
|
|||
the function fails, the error code can then be retrieved via
|
||||
:ref:`PR_GetError`.
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_DELETE
|
|||
|
||||
Allocates memory of a specified size from the heap.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -15,7 +14,6 @@ Syntax
|
|||
|
||||
void PR_DELETE(_ptr);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -25,14 +23,12 @@ Parameter
|
|||
(an expression that can appear on the left side of an assignment
|
||||
statement).
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
Nothing.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_DeleteSemaphore
|
|||
|
||||
Removes a semaphore specified by name from the system.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
NSPR_API(PRStatus) PR_DeleteSemaphore(const char *name);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -25,7 +23,6 @@ The function has the following parameter:
|
|||
The name of a semaphore that was previously created via a call to
|
||||
:ref:`PR_OpenSemaphore`.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_DeleteSharedMemory
|
|||
|
||||
Deletes a shared memory segment identified by name.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
const char *name
|
||||
);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -27,7 +25,6 @@ The function has these parameter:
|
|||
shm
|
||||
The handle returned from :ref:`PR_OpenSharedMemory`.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_DestroyCondVar
|
|||
|
||||
Destroys a condition variable.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
void PR_DestroyCondVar(PRCondVar *cvar);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,7 +22,6 @@ Parameter
|
|||
``cvar``
|
||||
A pointer to the condition variable object to be destroyed.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_DestroyLock
|
|||
|
||||
Destroys a specified lock object.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
void PR_DestroyLock(PRLock *lock);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,8 +22,6 @@ Parameter
|
|||
``lock``
|
||||
A pointer to a lock object.
|
||||
|
||||
.. _Caution:
|
||||
|
||||
Caution
|
||||
-------
|
||||
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_DestroyMonitor
|
|||
|
||||
Destroys a monitor object.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
void PR_DestroyMonitor(PRMonitor *mon);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,7 +22,6 @@ The function has the following parameter:
|
|||
``mon``
|
||||
A reference to an existing structure of type :ref:`PRMonitor`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_DestroyPollableEvent
|
|||
Close the file descriptor associated with a pollable event and release
|
||||
related resources.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -13,7 +12,6 @@ Syntax
|
|||
|
||||
NSPR_API(PRStatus) PR_DestroyPollableEvent(PRFileDesc *event);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,7 +22,6 @@ The function has the following parameter:
|
|||
Pointer to a :ref:`PRFileDesc` structure previously created via a call
|
||||
to :ref:`PR_NewPollableEvent`.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_DetachSharedMemory
|
|||
|
||||
Unmaps a shared memory segment identified by name.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -18,7 +17,6 @@ Syntax
|
|||
void *addr
|
||||
);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -30,7 +28,6 @@ shm
|
|||
addr
|
||||
The address to which the shared memory segment is mapped.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
|
|
@ -10,7 +10,6 @@ PR_DetachThread
|
|||
|
||||
Disassociates a PRThread object from a native thread.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -21,21 +20,18 @@ Syntax
|
|||
|
||||
void PR_DetachThread(void);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
||||
PR_DetachThread has no parameters.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
The function returns nothing.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_DisableClockInterrupts
|
|||
|
||||
Disables timer signals used for preemptive scheduling.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_dtoa
|
|||
|
||||
Converts a floating point number to a string.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -22,7 +21,6 @@ Syntax
|
|||
char *buf,
|
||||
PRSize bufsz);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -50,8 +48,6 @@ The function has these parameters:
|
|||
``bufsz``
|
||||
The size of the buffer provided to hold the result.
|
||||
|
||||
.. _Results:
|
||||
|
||||
Results
|
||||
~~~~~~~
|
||||
|
||||
|
@ -59,7 +55,6 @@ The principle output is the null-terminated string stored in ``buf``. If
|
|||
``rve`` is not ``NULL``, ``*rve`` is set to point to the end of the
|
||||
returned value.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_EnterMonitor
|
|||
|
||||
Enters the lock associated with a specified monitor.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -14,7 +13,6 @@ Syntax
|
|||
|
||||
void PR_EnterMonitor(PRMonitor *mon);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -24,7 +22,6 @@ The function has the following parameter:
|
|||
``mon``
|
||||
A reference to an existing structure of type :ref:`PRMonitor`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -5,7 +5,6 @@ PR_EnumerateAddrInfo
|
|||
Enumerates each of the possible network addresses of a ``PRAddrInfo``
|
||||
structure, acquired from :ref:`PR_GetAddrInfoByName`.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
~~~~~~
|
||||
|
@ -20,7 +19,6 @@ Syntax
|
|||
PRUint16 port,
|
||||
PRNetAddr *result);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -44,7 +42,6 @@ The function has the following parameters:
|
|||
structure is filled in by the runtime if the result of the call is
|
||||
not ``NULL``.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -53,7 +50,6 @@ The function returns the value you should specify in the ``enumPtr``
|
|||
parameter for the next call of the enumerator. If the function returns
|
||||
``NULL``, the enumeration is ended.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_EnumerateHostEnt
|
|||
Evaluates each of the possible addresses of a :ref:`PRHostEnt` structure,
|
||||
acquired from :ref:`PR_GetHostByName` or :ref:`PR_GetHostByAddr`.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -19,7 +18,6 @@ Syntax
|
|||
PRUint16 port,
|
||||
PRNetAddr *address);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -43,7 +41,6 @@ The function has the following parameters:
|
|||
structure is filled in by the runtime if the result of the call is
|
||||
greater than 0.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -56,7 +53,6 @@ The function returns one of the following values:
|
|||
- If unsuccessful, the function returns -1. You can retrieve the reason
|
||||
for the failure by calling :ref:`PR_GetError`.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -4,7 +4,6 @@ PR_ExitMonitor
|
|||
Decrements the entry count associated with a specified monitor and, if
|
||||
the entry count reaches zero, releases the monitor's lock.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -15,7 +14,6 @@ Syntax
|
|||
|
||||
PRStatus PR_ExitMonitor(PRMonitor *mon);
|
||||
|
||||
.. _Parameter:
|
||||
|
||||
Parameter
|
||||
~~~~~~~~~
|
||||
|
@ -27,7 +25,6 @@ The function has the following parameter:
|
|||
monitor object referenced must be one for which the calling thread
|
||||
currently holds the lock.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -38,7 +35,6 @@ The function returns one of the following values:
|
|||
- If unsuccessful (the calling thread has not entered the monitor),
|
||||
``PR_FAILURE``.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_ExplodeTime
|
|||
|
||||
Converts an absolute time to a clock/calendar time.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -17,7 +16,6 @@ Syntax
|
|||
PRTimeParamFn params,
|
||||
PRExplodedTime *exploded);
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -32,7 +30,6 @@ The function has these parameters:
|
|||
A pointer to a location where the converted time can be stored. This
|
||||
location must be preallocated by the caller.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
@ -40,7 +37,6 @@ Returns
|
|||
Nothing; the buffer pointed to by ``exploded`` is filled with the
|
||||
exploded time.
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
|
@ -3,7 +3,6 @@ PR_ExportFileMapAsString
|
|||
|
||||
Creates a string identifying a :ref:`PRFileMap`.
|
||||
|
||||
.. _Syntax:
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
@ -21,7 +20,6 @@ Syntax
|
|||
|
||||
#. define PR_FILEMAP_STRING_BUFSIZE 128
|
||||
|
||||
.. _Parameters:
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
|
@ -35,14 +33,12 @@ The function has the following parameters:
|
|||
``buf``
|
||||
A pointer to abuffer of length ``PR_FILEMAP_STRING_BUFSIZE``.
|
||||
|
||||
.. _Returns:
|
||||
|
||||
Returns
|
||||
~~~~~~~
|
||||
|
||||
:ref:`PRStatus`
|
||||
|
||||
.. _Description:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
|
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче