blob: faee7dfe15f15cf669a0ed7e6bee06877d4f3119 (
plain)
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;
|
