Layer4.Igmpv1MemberSession Class Reference

Methods
	Description.Get
	Returns a textual description of the object.
	Join
	Leave
	Multicast.Address.Get
	Returns the IP address of this IGMP session. More...
	Parent.Get
	Returns the parent object.
	Schedule.Add method
	Add a schedule for an action. More...
	Schedule.Get list
	Returns a list of scheduled actions. More...
	Schedule.Start
	Starts all schedules. More...
	Schedule.Stop
	Stops all schedules. More...
	Session.Info.Get
	Return the session info object of the IGMPv1 Session. More...

Class overview

Definition at line 8260 of file api.tcl.

Method documentation

Layer4.Igmpv1MemberSession::Multicast.Address.Get

Returns the IP address of this IGMP session.

Returns

The multicast IP

Example

$igmpv1MemberSession Multicast.Address.Get

Returns:

235.0.0.1 

Definition at line 8287 of file api.tcl.

Layer4.Igmpv1MemberSession::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

method

The method you wish to schedule. Allowed values are "join" and "leave".

Exceptions

ByteBlower.Exception.InvalidValue

When an unsupported method is given

Returns

The requested schedule

Definition at line 8306 of file api.tcl.

Layer4.Igmpv1MemberSession::Schedule.Get			list

Returns a list of scheduled actions.

list

of Layer4.Igmp.Schedule.Join and Layer4.Igmp.Schedule.Leave objects

Example

$igmpv1MemberSession Schedule.Get

Returns:

list of IgmpscheduleObjects 

Parameters

list	of Layer4.Igmp.Schedule.Join and Layer4.Igmp.Schedule.Leave objects

Definition at line 8324 of file api.tcl.

Layer4.Igmpv1MemberSession::Schedule.Start

Starts all schedules.

Example

$igmpv1MemberSession Schedule.Start

Definition at line 8334 of file api.tcl.

Layer4.Igmpv1MemberSession::Schedule.Stop

Stops all schedules.

Example

$igmpv1MemberSession Schedule.Stop

Definition at line 8344 of file api.tcl.

Layer4.Igmpv1MemberSession::Session.Info.Get

Return the session info object of the IGMPv1 Session.

Returns

The Layer4.Igmp.MemberSessionInfo object of this IGMPv1Session

Example

$igmpv1MemberSession Session.Info.Get

Returns:

<Layer4.Igmp.MemberSessionInfo object>  

Definition at line 8356 of file api.tcl.