Tx.Stream.ResultData Class Reference

Methods
	ByteCount.Get
	Gets the current transmitted bytes. More...
	Description.Get
	Returns a textual description of the object.
	Framesize.Max.Get
	Gets the largest framesize transmitted in this snapshot. More...
	Framesize.Maximum.Get
	Gets the largest framesize transmitted in this snapshot. More...
	Framesize.Min.Get
	Gets the smallest framesize transmitted in this snapshot. More...
	Framesize.Minimum.Get
	Gets the smallest framesize transmitted in this snapshot. More...
	Interval.Duration.Get
	Gets the configured duration of this results snapshot [NS]. More...
	PacketCount.Get
	Gets the transmitted packets. More...
	Parent.Get
	Returns the parent object.
	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 current timestamp [NS] of the last packet in this snapshot. More...

Class overview

Definition at line 23814 of file api.tcl.

Method documentation

Tx.Stream.ResultData::ByteCount.Get

Gets the current transmitted bytes.

Example

This example gets the transmitted bytes

$streamResultData ByteCount.Get

Returns:

100 

Definition at line 23824 of file api.tcl.

Tx.Stream.ResultData::Framesize.Max.Get

Gets the largest framesize transmitted in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

This example gets the largest framesize transmitted in this snapshot.

$streamResultData Framesize.Max.Get

Returns:

1024 

Definition at line 23841 of file api.tcl.

Tx.Stream.ResultData::Framesize.Maximum.Get

Gets the largest framesize transmitted in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Since

2.6.4

Example

This example gets the largest framesize transmitted in this snapshot.

$streamResultData Framesize.Maximum.Get

Returns:

1024 

Definition at line 23855 of file api.tcl.

Tx.Stream.ResultData::Framesize.Min.Get

Gets the smallest framesize transmitted in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Deprecated:

since 2.6.4, please use Framesize.Maximum.Get instead

Example

This example gets the smallest framesize transmitted in this snapshot.

$streamResultData Framesize.Min.Get

Returns:

60 

Definition at line 23869 of file api.tcl.

Tx.Stream.ResultData::Framesize.Minimum.Get

Gets the smallest framesize transmitted in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Since

2.6.4

Example

This example gets the smallest framesize transmitted in this snapshot.

$streamResultData Framesize.Min.Get

Returns:

60 

Definition at line 23883 of file api.tcl.

Tx.Stream.ResultData::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]

$streamResultData Interval.Duration.Get

Returns:

1000000000 

Definition at line 23895 of file api.tcl.

Tx.Stream.ResultData::PacketCount.Get

Gets the transmitted packets.

Example

This example gets the transmitted packets

$streamResultData PacketCount.Get

Returns:

100 

Definition at line 23905 of file api.tcl.

Tx.Stream.ResultData::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

$streamResultData Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 23922 of file api.tcl.

Tx.Stream.ResultData::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

$streamResultData Timestamp.Get

Returns:

1413475070000000000 

Definition at line 23932 of file api.tcl.

Tx.Stream.ResultData::Timestamp.Last.Get

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

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Deprecated:

since 2.6.4, please use Framesize.Maximum.Get instead

Example

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

$streamResultData Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 23946 of file api.tcl.