File: prfiledesc.rst

package info (click to toggle)
firefox-esr 115.14.0esr-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,659,200 kB
  • sloc: cpp: 6,676,648; javascript: 5,690,850; ansic: 3,328,545; python: 1,120,605; asm: 397,163; xml: 180,531; java: 178,838; sh: 68,930; makefile: 20,999; perl: 12,595; objc: 12,561; yacc: 4,583; cs: 3,846; pascal: 2,840; lex: 1,720; ruby: 1,079; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10
file content (53 lines) | stat: -rw-r--r-- 1,247 bytes parent folder | download | duplicates (16)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
PRFileDesc
==========

A file descriptor used to represent any open file, such as a normal
file, an end point of a pipe, or a socket (end point of network
communication).


Syntax
------

.. code::

   #include <prio.h>

   struct PRFileDesc {
     PRIOMethods *methods;
     PRFilePrivate *secret;
     PRFileDesc *lower, *higher;
     void (*dtor)(PRFileDesc *fd);
     PRDescIdentity identity;
   };

   typedef struct PRFileDesc PRFileDesc;


Parameters
~~~~~~~~~~

``methods``
   The I/O methods table. See :ref:`PRIOMethods`.
``secret``
   Layer-dependent implementation data. See :ref:`PRFilePrivate`.
``lower``
   Pointer to lower layer.
``higher``
   Pointer to higher layer.
``dtor``
   A destructor function for the layer.
``identity``
   Identity of this particular layer. See :ref:`PRDescIdentity`.


Description
-----------

The fields of this structure are significant only if you are
implementing a layer on top of NSPR, such as SSL. Otherwise, you use
functions such as :ref:`PR_Open` and :ref:`PR_NewTCPSocket` to obtain a file
descriptor, which you should treat as an opaque structure.

For more details about the use of :ref:`PRFileDesc` and related structures,
see `File Descriptor Types <I_O_Types#File_Descriptor_Types>`__.