summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getpeername.rst
blob: d45896444d9998154f72f9c5271fbae0a4d6e9ad (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
PR_GetPeerName
==============

Gets the network address of the connected peer.


Syntax
------

.. code::

   #include <prio.h>

   PRStatus PR_GetPeerName(
     PRFileDesc *fd,
     PRNetAddr *addr);


Parameters
~~~~~~~~~~

The function has the following parameters:

``fd``
   A pointer to a :ref:`PRFileDesc` object representing a socket.
``addr``
   On return, the address of the peer connected to the socket.


Returns
~~~~~~~

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful, ``PR_FAILURE``. The reason for the failure can be
   obtained by calling :ref:`PR_GetError`.