ByteBlowerPort.ResultRxData Class Reference

ByteBlower port counter result set. More...

Methods
	ByteCount.Get
	Gets the current received bytes counter. More...
	ByteCount.WithCRC.Get
	Gets the current received bytes counter with the CRC. More...
	Description.Get
	Returns a textual description of the object.
	Framesize.Maximum.Get
	Gets the largest frame size received in this snapshot. More...
	Framesize.Minimum.Get
	Gets the smallest frame size received in this snapshot. More...
	PacketCount.Get
	Gets the received packet count. 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

ByteBlower port counter result set.

A ByteBlower port result data snapshot object can be created via a ByteBlowerPort.ResultData or ByteBlowerPort.ResultSnapshot

Note

See What's new in API v2 for more information.

Example

Receive all frames on "trunk-1-2" of some server, matching UDP source or destination port 67.

set port [ $server Port.Create "trunk-1-2" ] 
 set resultHistory [ $port Result.History.Get ] 
 foreach resultset [ $resultHistory Cumulative.Get ] { 
 [ $resultset Rx.Unicast.Get ] PacketCount.Get 
 [ $resultset Rx.Broadcast.Get ] PacketCount.Get 
 [ $resultset Rx.All.Get ] PacketCount.Get 
 }

Definition at line 1207 of file api.tcl.

Method documentation

ByteBlowerPort.ResultRxData::ByteCount.Get

Gets the current received bytes counter.

Example

This example gets the received bytes counter

$portRxResult ByteCount.Get

Returns:

100 

Definition at line 1217 of file api.tcl.

ByteBlowerPort.ResultRxData::ByteCount.WithCRC.Get

Gets the current received bytes counter with the CRC.

Example

This example gets the received bytes counter

$portRxResult ByteCount.Get

Returns:

100 

Definition at line 1227 of file api.tcl.

ByteBlowerPort.ResultRxData::Framesize.Maximum.Get

Gets the largest frame size received in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

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

$portRxResult Framesize.Maximum.Get

Returns:

100 

Definition at line 1244 of file api.tcl.

ByteBlowerPort.ResultRxData::Framesize.Minimum.Get

Gets the smallest frame size received in this snapshot.

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

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

$portRxResult Framesize.Minimum.Get

Returns:

100 

Definition at line 1256 of file api.tcl.

ByteBlowerPort.ResultRxData::PacketCount.Get

Gets the received packet count.

Example

This example gets the received packet counter

$portRxResult PacketCount.Get

Returns:

100 

Definition at line 1266 of file api.tcl.

ByteBlowerPort.ResultRxData::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 received packet in this snapshot

$portRxResult Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 1283 of file api.tcl.

ByteBlowerPort.ResultRxData::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

$snapshot Timestamp.Get

Returns:

1413475070000000000 

Definition at line 1293 of file api.tcl.

ByteBlowerPort.ResultRxData::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 received packet in this snapshot

$portRxResult Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 1305 of file api.tcl.