Use this class to configure the source-specific properties of an IGMPv3 Multicast session. More...
Methods | |
| Description.Get | |
| Returns a textual description of the object. | |
| InitialTimeToWait.Get | |
| Returns the time when the action is scheduled. This time is set using InitialTimeToWait.Set At that time, the first frame will be sent. More... | |
| InitialTimeToWait.Set time | |
| Sets the time when the action will be scheduled. That is, when the first frame will be sent. More... | |
| MulticastSources.Get | |
| Gets the list of Multicast Sources for this Schedule. More... | |
| MulticastSources.Set multicastSources | |
| Configures the list of Multicast Sources for this Schedule. These sources will either be included or excluded. More... | |
| Parent.Get | |
| Returns the parent object. | |
| SourceFilter.Get | |
| Gets the currently set filter for the source specific multicast. | |
| SourceFilter.Set filter | |
| Sets the filter for the source specific multicast. You can choose between include and exclude. More... | |
| Start | |
| Starts the scheduled action. More... | |
| Stop | |
| Stops the running scheduled action. More... | |
Use this class to configure the source-specific properties of an IGMPv3 Multicast session.
Source-specific multicast (SSM) is a method of delivering multicast packets in which the only packets that are delivered to a receiver are those originating from a specific source address requested by the receiver. By so limiting the source, SSM reduces demands on the network and improves security.
SSM is possible in IPv4's IGMPv3 and IPv6's MLDv2, but this class can be used to configure IGMPv3 only.
You can set a filter to include or exclude a list of multicast sources.
This action is a schedule, so after configuring it, it needs to be started. See Start
Use Layer4.Igmpv3MemberSession::Schedule.Add <IpMulticastListen> to get an object of this class.
| Layer4.Igmp.Schedule.IpMulticastListen::InitialTimeToWait.Get |
Returns the time when the action is scheduled. This time is set using InitialTimeToWait.Set At that time, the first frame will be sent.
| Layer4.Igmp.Schedule.IpMulticastListen::InitialTimeToWait.Set | time | ||
Sets the time when the action will be scheduled. That is, when the first frame will be sent.
| time | The time when the action will be scheduled. Valid range: 0 to <max_uint64>[ns] Where
|
Sets the initial time to wait before the first frame will be sent. By default, the unit has a nanosecond resolution. But you can also provide a time unit.
The schedule can be started using Start
| <tcl_error> | Failed to parse time string: When the value could not be interpreted as a valid time string |
Set the initial time to wait to 9 ns
Set the initial time to wait to 1.25 milliseconds
Set the initial time to wait to 9 ms
Set the initial time to wait to 9 hours
| Layer4.Igmp.Schedule.IpMulticastListen::MulticastSources.Get |
| Layer4.Igmp.Schedule.IpMulticastListen::MulticastSources.Set | multicastSources | ||
Configures the list of Multicast Sources for this Schedule. These sources will either be included or excluded.
| multicastSources | A List of IPv4 Multicast Source Addresses. This may also be an empty list. |
Specify one multicast group source address
Specify two multicast group source addresses
Specify no multicast group source addresses at all
| Layer4.Igmp.Schedule.IpMulticastListen::SourceFilter.Set | filter | ||
Sets the filter for the source specific multicast. You can choose between include and exclude.
| filter | The source filter. Choose between
|
Set the filter to include
| Layer4.Igmp.Schedule.IpMulticastListen::Start |
