FrameSizeModifier.Result Class Reference

A collection of statistics containing the results of a frame size modifier. More...

Methods
	ByteCount.Get
	Returns the number of transmitted bytes. More...
	Description.Get
	Returns a textual description of the object.
	Framesize.Maximum.Get
	Returns the size of the biggest transmitted frame. More...
	Framesize.Minimum.Get
	Returns the size of the smallest transmitted frame. More...
	Interval.Duration.Get
	Gets the configured duration of this results snapshot [NS]. More...
	PacketCount.Get
	Returns the number of transmitted packets. More...
	Parent.Get
	Returns the parent object.
	Refresh.Timestamp.Get
	Returns the timestamp when the counters of this object where last refreshed. More...
	Refresh
	Updates the counters with the latest data available from the ByteBlower server. More...
	Timestamp.First.Get
	Gets the timestamp [NS] of the first packet in this snapshot. More...
	Timestamp.Get
	Gets the snapshot timestamp [NS]. More...
	Timestamp.Last.Get
	Gets the timestamp [NS] of the last packet in this snapshot. More...

Class overview

A collection of statistics containing the results of a frame size modifier.

There are currently 2 frame size modifiers available: The FrameSizeModifier.Growing, which is the Growing Size modifier, and the FrameSizeModifier.Random, which is the Random Size modifier.

Example

This example shows how to retrieve the number of packets handled by a FrameSizeModifier.Growing

set frame [ $stream Frame.Add ] 
 $frame Bytes.Set $bytes 
 set modifier [ $frame Modifier.Size.Set "growing" ] 
 set modifierResult [ $modifier Result.Get ] 
 $modifierResult PacketCount.Get

Returns:

60 

Definition at line 4500 of file api.tcl.

Method documentation

FrameSizeModifier.Result::ByteCount.Get

Returns the number of transmitted bytes.

Example

$modifierResult ByteCount.Get

Returns:

200 

Definition at line 4510 of file api.tcl.

FrameSizeModifier.Result::Framesize.Maximum.Get

Returns the size of the biggest transmitted frame.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

$modifierResult Framesize.Maximum.Get

Returns:

1000 

Definition at line 4527 of file api.tcl.

FrameSizeModifier.Result::Framesize.Minimum.Get

Returns the size of the smallest transmitted frame.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

$modifierResult Framesize.Minimum.Get

Returns:

63 

Definition at line 4539 of file api.tcl.

FrameSizeModifier.Result::Interval.Duration.Get

Gets the configured duration of this results snapshot [NS].

Since

2.3.0

Example

This example gets interval duration of this result snapshot [NS]

$modifierResult Interval.Duration.Get

Returns:

1000000000 

Definition at line 4551 of file api.tcl.

FrameSizeModifier.Result::PacketCount.Get

Returns the number of transmitted packets.

Example

$modifierResult PacketCount.Get

Returns:

200 

Example

$modifierResult PacketCount.Get 100

Returns:

20 

Example

$modifierResult PacketCount.Get 150

Returns:

180 

Definition at line 4569 of file api.tcl.

FrameSizeModifier.Result::Refresh

Updates the counters with the latest data available from the ByteBlower server.

Example

$modifierResult Refresh

Definition at line 4596 of file api.tcl.

FrameSizeModifier.Result::Refresh.Timestamp.Get

Returns the timestamp when the counters of this object where last refreshed.

Note

This is not the same as Timestamp.Get

Example

$modifierResult Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 4586 of file api.tcl.

FrameSizeModifier.Result::Timestamp.First.Get

Gets the timestamp [NS] of the first packet in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

This example gets the timestamp [NS] of the first transmitted packet in this snapshot

$modifierResult Timestamp.First.Get

Returns:

1413475070000000000 

Definition at line 4608 of file api.tcl.

FrameSizeModifier.Result::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

$modifierResult Timestamp.Get

Returns:

1413475070000000000 

Definition at line 4618 of file api.tcl.

FrameSizeModifier.Result::Timestamp.Last.Get

Gets the timestamp [NS] of the last packet in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

This example gets the timestamp [NS] of the last transmitted packet in this snapshot

$modifierResult Timestamp.Last.Get

Returns:

1413475070000000000 

Definition at line 4630 of file api.tcl.