File: pr_shutdown.rst

package info (click to toggle)
thunderbird 1%3A115.16.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,476,252 kB
  • sloc: cpp: 6,972,150; javascript: 5,209,211; ansic: 3,507,222; python: 1,137,609; asm: 432,531; xml: 205,149; java: 175,761; sh: 116,485; makefile: 22,152; perl: 13,971; objc: 12,561; yacc: 4,583; pascal: 2,840; lex: 1,720; ruby: 1,075; exp: 762; sql: 666; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (57 lines) | stat: -rw-r--r-- 1,153 bytes parent folder | download | duplicates (18) 
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
54
55
56
57
 
PR_Shutdown
===========

Shuts down part of a full-duplex connection on a specified socket.


Syntax
------

.. code::

   #include <prio.h>

   PRStatus PR_Shutdown(
     PRFileDesc *fd,
     PRShutdownHow how);


Parameters
~~~~~~~~~~

The function has the following parameters:

``fd``
   A pointer to a :ref:`PRFileDesc` object representing a connected socket.
``how``
   The kind of disallowed operations on the socket. Possible values
   include the following:

    - :ref:`PR_SHUTDOWN_RCV`. Further receives will be disallowed.
    - :ref:`PR_SHUTDOWN_SEND`. Further sends will be disallowed.
    - :ref:`PR_SHUTDOWN_BOTH`. Further sends and receives will be
      disallowed.


Returns
~~~~~~~

The function returns one of the following values:

-  Upon successful completion of shutdown request, ``PR_SUCCESS``.
-  If unsuccessful, ``PR_FAILURE``. Further information can be obtained
   by calling :ref:`PR_GetError`.


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

The ``PRShutdownHow`` enumeration is defined as follows:

.. code::

   typedef enum PRShutdownHow{
     PR_SHUTDOWN_RCV = 0,
     PR_SHUTDOWN_SEND = 1,
     PR_SHUTDOWN_BOTH = 2
   } PRShutdownHow;