A Stream.Mobile object configures a stream of frames that will be transmitted by a WirelessEndpoint. More...

Methods
	Description.Get
	Returns a textual description of the object.

	Destination.Address.Get
	Returns the destination address in the IP header of the frames that will be transmitted. More...

	Destination.Address.Set
	Sets the destination address in the IP header of the frames that will be transmitted. More...

	Destination.Port.Get
	Returns the destination port in the UDP header of the frames that will be transmitted. More...

	Destination.Port.Set
	Sets the destination port in the UDP header of the frames that will be transmitted. More...

	Frame.Add
	Adds a frame to the stream. More...

	Frame.Get
	Returns list of frames on this stream. More...

	InitialTimeToWait.Get
	Returns the time to wait before the first frame will be sent. More...

	InitialTimeToWait.Set duration
	Sets a delay before sending the first frame. More...

	InterFrameGap.Get
	Returns the inter-frame gap for the stream. More...

	InterFrameGap.Set duration
	Sets the inter-frame gap for the stream. More...

	NumberOfFrames.Get
	Returns the number of frames that will be transmitted by a stream. More...

	NumberOfFrames.Set count
	Sets the number of frames sent by a stream. More...

	Parent.Get
	Returns the parent object.

	Result.Clear
	Resets the current result counters to zero. More...

	Result.Get
	Returns the current result counters. More...

	Result.History.Get
	Returns the current History counters. More...

	Source.Port.Get
	Returns the source port in the UDP header of the frames that will be transmitted. More...

	Source.Port.Set
	Sets the source port in the UDP header of the frames that will be transmitted. More...

	TypeOfService.Get
	Returns the type-of-service field (or TOS bits) in the IP header of the frames that will be transmitted. More...

	TypeOfService.Set
	Sets the type-of-service field (or TOS bits) in the IP header of the frames that will be transmitted. More...

Class overview

A Stream.Mobile object configures a stream of frames that will be transmitted by a WirelessEndpoint.

The Stream.Mobile object allows you to add frame objects (Frame.Mobile) and configure parameters like the number of frames that will be transmitted, the inter-frame gap and the initial time to wait before transmission.

Since: 2.6.0

Example

This example will show a typical stream usage flow.

 set stream [ $device Tx.Stream.Add ] 
  $stream NumberOfFrames.Set 1000 
  $stream InterFrameGap.Set 100ms 
  $stream Destination.Address.Set [ $server_l3 Ip.Get ] 
  $stream Source.Port.Set 4096 
  $stream Destination.Port.Set 4096 
  set frame [ $stream Frame.Add ] 
  $frame Payload.Set "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"

Definition at line 23591 of file api.tcl.

Method documentation

Tx.Stream.Mobile::Destination.Address.Get

Returns the destination address in the IP header of the frames that will be transmitted.

Example

1 $stream Destination.Address.Get

Returns:

10.0.0.4

Definition at line 23606 of file api.tcl.

Tx.Stream.Mobile::Destination.Address.Set

Sets the destination address in the IP header of the frames that will be transmitted.

Example

1 $stream Destination.Address.Set 10.0.0.4

Definition at line 23616 of file api.tcl.

Tx.Stream.Mobile::Destination.Port.Get

Returns the destination port in the UDP header of the frames that will be transmitted.

Example

1 $stream Destination.Port.Get

Returns:

Definition at line 23626 of file api.tcl.

Tx.Stream.Mobile::Destination.Port.Set

Sets the destination port in the UDP header of the frames that will be transmitted.

Example

1 $stream Destination.Port.Set 1024

Definition at line 23636 of file api.tcl.

Tx.Stream.Mobile::Frame.Add

Adds a frame to the stream.

Example

This example adds a frame to a stream.

1 $stream Frame.Add

Returns:

<Frame object>

Definition at line 23646 of file api.tcl.

Tx.Stream.Mobile::Frame.Get

Returns list of frames on this stream.

Example

This example lists the frames of a stream.

1 $stream Frame.Get

Returns:

[ <Frame object> ... ]

Definition at line 23656 of file api.tcl.

Tx.Stream.Mobile::InitialTimeToWait.Get

Returns the time to wait before the first frame will be sent.

Returns: The initial time to wait in nanoseconds.

Example

This example gets the current initial time to wait from a stream.

1 $stream InitialTimeToWait.Get

Returns:

9000000000

This stream will thus wait 9s before transmitting the first frame

Definition at line 23668 of file api.tcl.

Tx.Stream.Mobile::InitialTimeToWait.Set			duration

Sets a delay before sending the first frame.

Parameters

duration

The amount of time to wait before sending the first frame.

ns: nanoseconds
us: microseconds
ms: milliseconds
s: seconds

Default: ns

Example

This example sets the initial time to wait before sending the first frame.

1 $stream InitialTimeToWait.Set 9ms

Definition at line 23680 of file api.tcl.

Tx.Stream.Mobile::InterFrameGap.Get

Returns the inter-frame gap for the stream.

Returns: The inter-frame gap is returned in nanoseconds.

Example

This example gets the inter-frame gap of a stream.

1 $stream InterframeGap.Get

Returns:

Definition at line 23692 of file api.tcl.

Tx.Stream.Mobile::InterFrameGap.Set			duration

Sets the inter-frame gap for the stream.

Parameters

duration

A time unit can be specified as a suffix. E.g: 20ms. If no time unit is specified then nanoseconds are used.

ns: nanoseconds
us: microseconds
ms: milliseconds
s: seconds

Default: ns

Example

This example sets the inter-frame gap on a stream.

1 $stream InterframeGap.Set 10us

Definition at line 23704 of file api.tcl.

Tx.Stream.Mobile::NumberOfFrames.Get

Returns the number of frames that will be transmitted by a stream.

Example

This example gets the frame count of the stream.

1 $stream NumberOfFrames.Get

Returns:

Definition at line 23714 of file api.tcl.

Tx.Stream.Mobile::NumberOfFrames.Set			count

Sets the number of frames sent by a stream.

This method configures the number of frames a stream will transmit.

Parameters

count The number of frames to send.

Example

This example sets the frame count of the stream.

1 $stream NumberOfFrames.Set 100

Definition at line 23728 of file api.tcl.

Tx.Stream.Mobile::Result.Clear

Resets the current result counters to zero.

Example

1 $stream Result.Clear

Definition at line 23743 of file api.tcl.

Tx.Stream.Mobile::Result.Get

Returns the current result counters.

Returns: The OID of the Tx.Stream.ResultSnapshot object.

Example

1 $stream Result.Get

Returns:

<Tx.Stream.ResultSnapshot object>

Definition at line 23755 of file api.tcl.

Tx.Stream.Mobile::Result.History.Get

Returns the current History counters.

Returns: The OID of the Tx.Stream.ResultHistory object.

Example

1 $stream Results.History.Get

Returns:

<Tx.Stream.ResultHistory object>

Definition at line 23767 of file api.tcl.

Tx.Stream.Mobile::Source.Port.Get

Returns the source port in the UDP header of the frames that will be transmitted.

Example

1 $stream Source.Port.Get

Returns:

Definition at line 23777 of file api.tcl.

Tx.Stream.Mobile::Source.Port.Set

Sets the source port in the UDP header of the frames that will be transmitted.

Example

1 $stream Source.Port.Set 1024

Definition at line 23787 of file api.tcl.

Tx.Stream.Mobile::TypeOfService.Get

Returns the type-of-service field (or TOS bits) in the IP header of the frames that will be transmitted.

Example

1 $stream TypeOfService.Get

Returns:

Definition at line 23797 of file api.tcl.

Tx.Stream.Mobile::TypeOfService.Set

Sets the type-of-service field (or TOS bits) in the IP header of the frames that will be transmitted.

Example

1 $stream TypeOfService.Set 1

Definition at line 23807 of file api.tcl.

Methods

Class overview

Method documentation