Tx.Stream.ResultSnapshot 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 frame size transmitted in this snapshot. More...
	Framesize.Maximum.Get
	Gets the largest frame size transmitted in this snapshot. More...
	Framesize.Min.Get
	Gets the smallest frame size transmitted in this snapshot. More...
	Framesize.Minimum.Get
	Gets the smallest frame size 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.
	Refresh.Timestamp.Get
	Returns the timestamp when the counters of this object where last refreshed. More...
	Refresh
	Updates the snapshot 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 current timestamp [NS] of the last packet in this snapshot. More...

Class overview

Definition at line 24231 of file api.tcl.

Method documentation

Tx.Stream.ResultSnapshot::ByteCount.Get

Gets the current transmitted bytes.

Example

This example gets the transmitted bytes

$streamResultData ByteCount.Get

Returns:

100 

Definition at line 24241 of file api.tcl.

Tx.Stream.ResultSnapshot::Framesize.Max.Get

Gets the largest frame size transmitted in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Deprecated:

since 2.5.0, please use Framesize.Maximum.Get instead

Example

This example gets the largest frame size transmitted in this snapshot.

$streamResultData Framesize.Max.Get

Returns:

100 

Definition at line 24260 of file api.tcl.

Tx.Stream.ResultSnapshot::Framesize.Maximum.Get

Gets the largest frame size transmitted in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Since

2.5.0

Example

This example gets the largest frame size transmitted in this snapshot.

$streamResultData Framesize.Maximum.Get

Returns:

100 

Definition at line 24274 of file api.tcl.

Tx.Stream.ResultSnapshot::Framesize.Min.Get

Gets the smallest frame size transmitted in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Deprecated:

since 2.5.0, please use Framesize.Minimum.Get instead

Example

This example gets the smallest frame size transmitted in this snapshot.

$streamResultData Framesize.Min.Get

Returns:

100 

Definition at line 24288 of file api.tcl.

Tx.Stream.ResultSnapshot::Framesize.Minimum.Get

Gets the smallest frame size transmitted in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Since

2.5.0

Example

This example gets the smallest frame size transmitted in this snapshot.

$streamResultData Framesize.Minimum.Get

Returns:

100 

Definition at line 24302 of file api.tcl.

Tx.Stream.ResultSnapshot::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 24314 of file api.tcl.

Tx.Stream.ResultSnapshot::PacketCount.Get

Gets the transmitted packets.

Example

This example gets the transmitted packets

$streamResultData PacketCount.Get

Returns:

100 

Definition at line 24324 of file api.tcl.

Tx.Stream.ResultSnapshot::Refresh

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

Example

$streamResultData Refresh

Definition at line 24351 of file api.tcl.

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

$streamResultData Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 24341 of file api.tcl.

Tx.Stream.ResultSnapshot::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 24363 of file api.tcl.

Tx.Stream.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

$streamResultData Timestamp.Get

Returns:

1413475070000000000 

Definition at line 24373 of file api.tcl.

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

Example

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

$streamResultData Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 24385 of file api.tcl.