Layer4.Igmp Class Reference

The Internet Group Management Protocol (IGMP) Protocol for IPv4 manages multicast group membership for a given IPv4 host. More...

Methods
	Description.Get
	Returns a textual description of the object.
	Destructor
	Parent.Get
	Returns the parent object.
	Protocol.Info.Get
	returns Layer4.Igmp.ProtocolInfo object containing various stats of the IGMPProtocol More...
	Session.Get
	Returns a list of existing IGMPSessions. More...
	Session.V1.Add multicast
	Adding a IGMPv1 Session. More...
	Session.V2.Add multicast
	Adding a IGMPv2 Session. More...
	Session.V3.Add multicast
	Adding a IVMPv3 Session. More...

Class overview

The Internet Group Management Protocol (IGMP) Protocol for IPv4 manages multicast group membership for a given IPv4 host.

This class support three IGMP Protocol versions:

IGMPv1

RFC1112

IGMPv2

RFC2236. IGMPv2 allows group membership termination to be quickly reported to the routing protocol, which is important for high-bandwidth multicast groups and/or subnets with highly volatile group membership.

IGMPv3

RFC3376. Version 3 of IGMP adds support for "source filtering", that is, the ability for a system to report interest in receiving packets only from specific source addresses, or from all but specific source addresses, sent to a particular multicast address. That information may be used by multicast routing protocols to avoid delivering multicast packets from specific sources to networks where there are no interested receivers.

Definition at line 8174 of file api.tcl.

Method documentation

Layer4.Igmp::Protocol.Info.Get

returns Layer4.Igmp.ProtocolInfo object containing various stats of the IGMPProtocol

Example

$igmpProtocol Protocol.Info.Get

Returns:

<Layer4.Igmp.ProtocolInfo object> 

Definition at line 8199 of file api.tcl.

Layer4.Igmp::Session.Get

Returns a list of existing IGMPSessions.

Returns

List of all IGMPSessionObjects created on this IGMPProtocol. May be empty

Example

$igmpProtocol Session.Get

Returns:

[ <IGMPSession object>=""> .. ] 

Definition at line 8211 of file api.tcl.

Layer4.Igmp::Session.V1.Add			multicast

Adding a IGMPv1 Session.

Parameters

multicast

IP address for this session

Returns

Object of type Layer4.Igmpv1MemberSession

Example

$igmpProtocol Session.V1.Add 235.0.0.1

Returns:

<Layer4.Igmpv1MemberSession object> 

Definition at line 8225 of file api.tcl.

Layer4.Igmp::Session.V2.Add			multicast

Adding a IGMPv2 Session.

Parameters

multicast

IP address for this session

Returns

Object of type Layer4.Igmpv2MemberSession

Example

$igmpProtocol Session.V2.Add 235.0.0.1

Returns:

<Layer4.Igmpv2MemberSession object> 

Definition at line 8239 of file api.tcl.

Layer4.Igmp::Session.V3.Add			multicast

Adding a IVMPv3 Session.

Parameters

multicast

IP address for this session

Returns

Object of type Layer4.Igmpv3MemberSession

Example

$igmpProtocol Session.V3.Add 235.0.0.1

Returns:

<Layer4.Igmpv3MemberSession object> 

Definition at line 8253 of file api.tcl.