ScheduleGroup Class Reference

A collection of schedulable objects that can be started. More...

Methods
	Description.Get
	Returns a textual description of the object.
	Members.Add SchedulableObject
	This method will add a Schedulable object to the ScheduleGroup. More...
	Members.Clear
	This method will remove all members from the schedulegroup. More...
	Members.Get
	Returns a list of ToopOIDs of the members of this group. More...
	Members.Length.Get
	This method returns the number of members in the scheduleGroup. More...
	Members.Remove SchedulableObject
	This method will remove s SchedulableObject from the group. More...
	Parent.Get
	Returns the parent object.
	Prepare
	This method will prepare all the schedules, but NOT start them. More...
	Start
	This method will start the schedules. The Schedules must be in the prepared state. More...
	Status.Get
	Returns the status of the ScheduleGroup. More...
	Stop
	This method will stop the schedules. More...

Class overview

A collection of schedulable objects that can be started.

Definition at line 22611 of file api.tcl.

Method documentation

ScheduleGroup::Members.Add			SchedulableObject

This method will add a Schedulable object to the ScheduleGroup.

Parameters

SchedulableObject

A ScheduleObject or Tx.Stream which will be added to the ScheduleGroup.

Example

add a HTTPClient to the group

$schedulegroup Members.Add $httpClient

Example

add multiple schedulable objects at once

$schedulegroup Members.Add $httpClient $stream $igmp

Definition at line 22632 of file api.tcl.

ScheduleGroup::Members.Clear

This method will remove all members from the schedulegroup.

Example

remove all members from the group

$schedulegroup Members.Clear

Definition at line 22642 of file api.tcl.

ScheduleGroup::Members.Get

Returns a list of ToopOIDs of the members of this group.

Returns

List of schedulable objects in order of addition. Possible empty. Their individual object types depend on the types used in Members.Add:

HTTPClient

Layer5.Http.Client

IcmpEchoSession

Layer3.IcmpEchoSession

Icmpv6EchoSession

Layer3.Icmpv6EchoSession

Igmp Join

Layer4.Igmp.Schedule.Join

Igmp Leave

Layer4.Igmp.Schedule.Leave

Igmp IpMulticastListen

Layer4.Igmp.Schedule.IpMulticastListen

Mld StartListening

Layer4.Mld.Schedule.StartListening

Mld StopListening

Layer4.Mld.Schedule.StopListening

Mld Ipv6MulticastListen

Layer4.Mld.Schedule.Ipv6MulticastListen

TxStream

Tx.Stream

Example

return the ObjectID of the members

$schedulegroup Members.Get

Returns:

<objectID>  

Definition at line 22654 of file api.tcl.

ScheduleGroup::Members.Length.Get

This method returns the number of members in the scheduleGroup.

Returns

Size of memberlist

Example

add a HTTPClient to the group

$schedulegroup Members.Length.Get

Returns:

3 

Definition at line 22666 of file api.tcl.

ScheduleGroup::Members.Remove			SchedulableObject

This method will remove s SchedulableObject from the group.

Parameters

SchedulableObject

The object which will be removed from this group.

Example

remove a igmp from the scheduleGroup

$schedulegroup Members.Remove $igmp

Example

remove multiple objects at once

$schedulegroup Members.Remove $igmp1 $igmp2 $igmp3

Definition at line 22682 of file api.tcl.

ScheduleGroup::Prepare

This method will prepare all the schedules, but NOT start them.

Exceptions

If	one of the Schedules fail to prepare, the others are canceled and an exception is thrown. This exception will contain information about the object which caused it.

Example

Preparing the scheduleGroup

$schedulegroup Prepare

Definition at line 22699 of file api.tcl.

ScheduleGroup::Start

This method will start the schedules. The Schedules must be in the prepared state.

Exceptions

ByteBlower.Exception.ScheduleNotPrepared

The schedulegroup must be prepared before it can be started.

Example

Start the ScheduleGroup

$schedulegroup Start

Definition at line 22711 of file api.tcl.

ScheduleGroup::Status.Get

Returns the status of the ScheduleGroup.

Returns

• configure
• prepared
• started
• stopped
• error

Example

Start the scheduleGroup

$schedulegroup Status.Get

Returns:

configure 

Definition at line 22723 of file api.tcl.

ScheduleGroup::Stop

This method will stop the schedules.

Exceptions

ByteBlower.Exception.ScheduleNotRunning

You can only stop a schedule that is running.

Example

Stop the scheduleGroup

$schedulegroup Stop

Definition at line 22735 of file api.tcl.