Class UDPSetOptionCommand

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

C++ definition

Base class for UDP socket option control info classes.

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
UDPControlInfo	class	Base class for UDP control info classes. The most convenient way to handle UDP is the UDPSocket class, which hides control info from you.

Known subclasses:

Name	Type	Description
UDPBlockMulticastSourcesCommand	class	Control info for letting an UDP socket to block multicast traffic from specific sources after joining a multicast group.
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.
UDPJoinMulticastSourcesCommand	class	Control info for letting an UDP socket to join a multicast group only for the selected sources.
UDPLeaveMulticastGroupsCommand	class	Control info for letting an UDP socket leave 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.
UDPLeaveMulticastSourcesCommand	class	Control info for letting an UDP socket to leave a multicast group for the selected sources.
UDPSetBroadcastCommand	class	Control info for setting the Broadcast option on an UDP socket. 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.
UDPSetMulticastInterfaceCommand	class	Control info for setting the multicast output interface for an UDP socket. 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.
UDPSetMulticastLoopCommand	class	Control info for setting the multicast loop option for an UDP socket. When the option is true, a copy of the outgoing multicast packet is delivered locally via the loopback interface. To set the option, send a message to the UDP module with kind=UDP_C_SETOPTION and an instance of this control info class attached.
UDPSetMulticastSourceFilterCommand	class	Control info for letting an UDP socket to specify the excluded/included sources for a multicast group.
UDPSetReuseAddressCommand	class	Control info for setting the ReuseAddress option on an UDP socket. When the option is true, then the socket is allowed to bind to an already bound local address. 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.
UDPSetTimeToLiveCommand	class	Control info for setting the Time To Live (a.k.a. Hop Limit) option on an UDP socket. This option will affect both multicast and unicast packets. 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.
UDPSetTypeOfServiceCommand	class	Control info for setting the Type of Service (IPv4) or Traffic Class (IPv6) header field on outgoing IPv4/IPv6 packets sent from an UDP socket. This is an 8-bit field, the lowest 6 bits are the DSCP (DiffServ Code Point) and the highest 2 bits are the ECN (Explicit Congestion Notification). 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.
UDPUnblockMulticastSourcesCommand	class	Control info for letting an UDP socket to permit multicast traffic from a previously blocked source.

Fields:

Name	Type	Description
sockId	int	must uniquely identify the socket in the UDP module

Source code:

//
// Base class for UDP socket option control info classes.
//
class UDPSetOptionCommand extends UDPControlInfo
{
}