File: pr_shutdown.rst

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (57 lines) | stat: -rw-r--r-- 1,144 bytes parent folder | download
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:

    - ``PR_SHUTDOWN_RCV``. Further receives will be disallowed.
    - ``PR_SHUTDOWN_SEND``. Further sends will be disallowed.
    - ``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;