ByteBlowerPort.ResultSnapshot Class Reference

ByteBlower port counter result set. More...

Methods
	Description.Get
	Returns a textual description of the object.
	Interval.Duration.Get
	Gets the configured duration of this results snapshot [NS]. More...
	Parent.Get
	Returns the parent object.
	Refresh.Timestamp.Get
	Returns the timestamp on the server when the current snapshot is requested. More...
	Refresh
	Refresh the counters in this object.
	Rx.All.Get
	Gets the received counters for the port. This will return a ByteBlowerPort.ResultRxData object which contain all counters from a port. More...
	Rx.Broadcast.Get
	Gets the received broadcast counters for the port. This will return a ByteBlowerPort.ResultRxData object which contain all counters from a port. This will only contain the broadcast packets received on the port. More...
	Rx.Unicast.Get
	Gets the received unicast counters for the port. This will return a ByteBlowerPort.ResultRxData object which contain all unicast counters from a port. This will only contain the broadcast unicast received on the port. More...
	Timestamp.Get
	Gets the snapshot timestamp [NS]. More...

Class overview

ByteBlower port counter result set.

The result set contains three different counters:

• a Unicast counter, which counts all received unicast Ethernet frames.
• a Broadcast counter, which counts all received broadcast Ethernet frames.
• an All counter, which counts all received Ethernet frames.

Note

The "all" counter can be seen as the combination of the unicast and the broadcast counter.

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

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

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 1331 of file api.tcl.

Method documentation

ByteBlowerPort.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]

$snapshot Interval.Duration.Get

Returns:

1000000000 

Definition at line 1348 of file api.tcl.

ByteBlowerPort.ResultSnapshot::Refresh.Timestamp.Get

Returns the timestamp on the server when the current snapshot is requested.

When the snapshot is part of a history, the refresh timestamp will be the same as refresh timestamp of the History object.

Note

This is not the same as Timestamp.Get

Returns

Timestamp on the server when the current snapshot is requested in nanoseconds since epoch

Example

$snapshot Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 1369 of file api.tcl.

ByteBlowerPort.ResultSnapshot::Rx.All.Get

Gets the received counters for the port. This will return a ByteBlowerPort.ResultRxData object which contain all counters from a port.

Returns

ByteBlowerPort.ResultRxData

Example

set snapshot [ $port Result.Get ] 
 $snapshot Rx.All.Get

Returns:

<ByteBlowerPort.ResultRxData object> 

Definition at line 1384 of file api.tcl.

ByteBlowerPort.ResultSnapshot::Rx.Broadcast.Get

Gets the received broadcast counters for the port. This will return a ByteBlowerPort.ResultRxData object which contain all counters from a port. This will only contain the broadcast packets received on the port.

Returns

ByteBlowerPort.ResultRxData

Example

set snapshot [ $port Result.Get ] 
 $snapshot Rx.Broadcast.Get

Returns:

<ByteBlowerPort.ResultRxData object> 

Definition at line 1393 of file api.tcl.

ByteBlowerPort.ResultSnapshot::Rx.Unicast.Get

Gets the received unicast counters for the port. This will return a ByteBlowerPort.ResultRxData object which contain all unicast counters from a port. This will only contain the broadcast unicast received on the port.

Returns

ByteBlowerPort.ResultRxData

Example

set snapshot [ $port Result.Get ] 
 $snapshot Rx.Unicast.Get

Returns:

<ByteBlowerPort.ResultRxData object> 

Definition at line 1402 of file api.tcl.

ByteBlowerPort.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

$snapshot Timestamp.Get

Returns:

1413475070000000000 

Definition at line 1412 of file api.tcl.