Class UDPJoinMulticastGroupsCommand

File: src/inet/transportlayer/contract/udp/UDPControlInfo.msg

Control info for letting an UDP socket join multicast groups. To set the option, send a message to the UDP module with kind=UDP_C_SETOPTION and an and instance of this control info class attached.

The address-interfaceId pairs are passed as two separate arrays. When there are less interfaceIds than multicast addresses, then -1 is assumed (meaning join on all interfaces).

See also: UDPCommandCode

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends:

Name	Type	Description
UDPSetOptionCommand	class	Base class for UDP socket option control info classes.

Fields:

Name	Type	Description
multicastAddr	L3Address[]
interfaceId	int[]
sockId	int	must uniquely identify the socket in the UDP module

Source code:

//
// Control info for letting an UDP socket join multicast groups.
// To set the option, send a message to the ~UDP module with kind=UDP_C_SETOPTION
// and an and instance of this control info class attached.
//
// The address-interfaceId pairs are passed as two separate arrays.
// When there are less interfaceIds than multicast addresses,
// then -1 is assumed (meaning join on all interfaces).
//
// @see ~UDPCommandCode
//
class UDPJoinMulticastGroupsCommand extends UDPSetOptionCommand
{
    L3Address multicastAddr[];
    int interfaceId[];
}