UDPJoinMulticastGroupsCommand

Namespace inet

UDPJoinMulticastGroupsCommand

class

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

Extends

Name Type Description
UDPSetOptionCommand (unknown -- not in documented files)

Fields

Name Type Description
multicastAddr L3Address[]
interfaceId int[]

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[];
}

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