summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/prmcastrequest.rst
blob: 9c7c63ecef8b8f970b941d105e3fb2539dad4e73 (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
PRMcastRequest
==============

Structure used to specify values for the ``PR_SockOpt_AddMember`` and
``PR_SockOpt_DropMember`` socket options that define a request to join
or leave a multicast group.


Syntax
------

.. code::

   #include <prio.h>

   struct PRMcastRequest {
     PRNetAddr mcaddr;
     PRNetAddr ifaddr;
   };

   typedef struct PRMcastRequest PRMcastRequest;


Fields
~~~~~~

The structure has the following fields:

``mcaddr``
   IP multicast address of group.
``ifaddr``
   Local IP address of interface.


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

The ``mcaddr`` and ``ifaddr`` fields are of the type :ref:`PRNetAddr`, but
their ``port`` fields are ignored. Only the IP address (``inet.ip``)
fields are used.