summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_newudpsocket.rst
blob: 67aff3e5d4bfafffe9c0dcbf462ea1a6a982e133 (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
PR_NewUDPSocket
===============

Creates a new UDP socket.


Syntax
------

.. code::

   #include <prio.h>

   PRFileDesc* PR_NewUDPSocket(void);


Returns
~~~~~~~

The function returns one of the following values:

-  Upon successful completion, a pointer to the :ref:`PRFileDesc` object
   created for the newly opened UDP socket.
-  If the creation of a new UDP socket failed, ``NULL``.


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

UDP (User Datagram Protocol) is a connectionless, unreliable datagram
protocol of the TCP/IP protocol suite. UDP datagrams may be lost or
delivered in duplicates or out of sequence.

:ref:`PR_NewUDPSocket` creates a new UDP socket. The socket may be bound to
a well-known port number with :ref:`PR_Bind`. Datagrams can be sent with
:ref:`PR_SendTo` and received with :ref:`PR_RecvFrom`. When the socket is no
longer needed, it should be closed with a call to :ref:`PR_Close`.


See Also
--------

:ref:`PR_NewUDPSocket` is deprecated because it is hardcoded to create an
IPv4 UDP socket. New code should use :ref:`PR_OpenUDPSocket` instead, which
allows the address family (IPv4 or IPv6) of the new UDP socket to be
specified.