All Classes Namespaces Files Functions Pages
Layer4.Igmpv2MemberSession Class Reference

Methods

 Description.Get
 Returns a textual description of the object.
 
 Join
 
 Leave
 
 Multicast.Address.Get
 
 Parent.Get
 Returns the parent object.
 
 Schedule.Add method
 Add a schedule for an action. More...
 
 Schedule.Get
 
 Schedule.Start
 Starts all schedules.
 
 Schedule.Stop
 Stops all schedules.
 
 Session.Info.Get
 Return the sessioninfo object of the IGMPv2Session. More...
 

Class overview

Definition at line 8363 of file api.tcl.

Method documentation

Layer4.Igmpv2MemberSession::Schedule.Add   method  

Add a schedule for an action.

The returned value is:

Layer4.Igmp.Schedule.Join
for method "join"
Layer4.Igmp.Schedule.Leave
for method "leave"
Parameters
methodThe method you wish to schedule. Allowed values are "join" and "leave".
Exceptions
ByteBlower.Exception.InvalidValueWhen an unsupported method is given
Returns
The requested schedule

Definition at line 8402 of file api.tcl.

Layer4.Igmpv2MemberSession::Session.Info.Get

Return the sessioninfo object of the IGMPv2Session.

Returns
The Layer4.Igmp.MemberSessionInfo object of this IGMPv1Session
Example
1 $igmpv2MemberSession Session.Info.Get

Returns:

<Layer4.Igmp.MemberSessionInfo object>  

Definition at line 8431 of file api.tcl.