blob: bfc1b7e5f9d18949f57c03cb2d429b62ee546a5e (
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
|
PR_Recv
=======
Receives bytes from a connected socket.
Syntax
------
.. code::
#include <prio.h>
PRInt32 PR_Recv(
PRFileDesc *fd,
void *buf,
PRInt32 amount,
PRIntn flags,
PRIntervalTime timeout);
Parameters
~~~~~~~~~~
The function has the following parameters:
``fd``
A pointer to a :ref:`PRFileDesc` object representing a socket.
``buf``
A pointer to a buffer to hold the data received.
``amount``
The size of ``buf`` (in bytes).
``flags``
Must be zero or ``PR_MSG_PEEK``.
``timeout``
A value of type :ref:`PRIntervalTime` specifying the time limit for
completion of the receive operation.
Returns
~~~~~~~
The function returns one of the following values:
- A positive number indicates the number of bytes actually received.
- The value 0 means the network connection is closed.
- The value -1 indicates a failure. The reason for the failure can be
obtained by calling :ref:`PR_GetError`.
Description
-----------
:ref:`PR_Recv` blocks until some positive number of bytes are transferred,
a timeout occurs, or an error occurs. No more than ``amount`` bytes will
be transferred.
|
