From 26a029d407be480d791972afb5975cf62c9360a6 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Fri, 19 Apr 2024 02:47:55 +0200
Subject: Adding upstream version 124.0.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 docs/nspr/reference/prfiledesc.rst | 53 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 docs/nspr/reference/prfiledesc.rst

(limited to 'docs/nspr/reference/prfiledesc.rst')

diff --git a/docs/nspr/reference/prfiledesc.rst b/docs/nspr/reference/prfiledesc.rst
new file mode 100644
index 0000000000..50df48f83f
--- /dev/null
+++ b/docs/nspr/reference/prfiledesc.rst
@@ -0,0 +1,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>`__.
-- 
cgit v1.2.3