All Classes Namespaces Files Functions Pages
Rx.Trigger.Basic.ResultSnapshot Class Reference

Receive-side trigger result set. More...

Methods

 ByteCount.Get
 Gets the current received bytes counter. More...
 
 Description.Get
 Returns a textual description of the object.
 
 Framesize.Max.Get
 Gets the size (in bytes) of the largest frame received in this snapshot. More...
 
 Framesize.Maximum.Get
 Gets the size (in bytes) of the largest frame received in this snapshot. More...
 
 Framesize.Min.Get
 Gets the size (in bytes) of the smallest frame received in this snapshot. More...
 
 Framesize.Minimum.Get
 Gets the size (in bytes) of the smallest frame received in this snapshot. More...
 
 Interval.Duration.Get
 Gets the configured duration of this results snapshot [NS]. More...
 
 PacketCount.Get
 Gets the received packet count. 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

Receive-side trigger result set.

The result set contains the trigger information of since the object is created or refreshed.

Note
The information is not updated until Refresh is called
See What's new in API v2 for more information.

A basic trigger result snapshot object can be created via a Rx.Trigger.Basic, using Rx.Trigger.Basic::Result.Get

Example

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

1 set port [ $server Port.Create "trunk-1-2" ]
2  set trigger [ $port Rx.Trigger.Basic.Add ]
3  $trigger Filter.Set "udp port 67"
4  set results [ $trigger Result.Get ]
5  $results PacketCount.Get

Definition at line 21337 of file api.tcl.

Method documentation

Rx.Trigger.Basic.ResultSnapshot::ByteCount.Get

Gets the current received bytes counter.

Returns
received bytes
Example

This example gets the received bytes counter

1 $triggerResult ByteCount.Get

Returns:

100 

Definition at line 21349 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::Framesize.Max.Get

Gets the size (in bytes) of the largest frame received in this snapshot.

Returns
Largest received frame size in bytes of this snapshot
Deprecated:
since 2.5.0, please use Framesize.Maximum.Get instead
Example

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

1 $triggerResult Framesize.Max.Get

Returns:

1024 

Definition at line 21368 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::Framesize.Maximum.Get

Gets the size (in bytes) of the largest frame received in this snapshot.

Returns
Largest received frame size in bytes of this snapshot
Since
2.5.0
Example

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

1 $triggerResult Framesize.Maximum.Get

Returns:

1024 

Definition at line 21382 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::Framesize.Min.Get

Gets the size (in bytes) of the smallest frame received in this snapshot.

Returns
Smallest received framesize in bytes of this snapshot
Deprecated:
since 2.5.0, please use Framesize.Minimum.Get instead
Example

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

1 $triggerResult Framesize.Min.Get

Returns:

60 

Definition at line 21396 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::Framesize.Minimum.Get

Gets the size (in bytes) of the smallest frame received in this snapshot.

Returns
Smallest received frame size in bytes of this snapshot
Since
2.5.0
Example

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

1 $triggerResult Framesize.Minimum.Get

Returns:

60 

Definition at line 21410 of file api.tcl.

Rx.Trigger.Basic.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]

1 $triggerResult Interval.Duration.Get

Returns:

1000000000 

Definition at line 21422 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::PacketCount.Get

Gets the received packet count.

Returns
received packets
Example

This example gets the received packet counter

1 $triggerResult PacketCount.Get

Returns:

100 

Definition at line 21434 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::Refresh

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

Example
1 $triggerResult Refresh

Definition at line 21463 of file api.tcl.

Rx.Trigger.Basic.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
Returns
RefreshTimestamp in nanoseconds
Example
1 $triggerResult Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 21453 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::Timestamp.First.Get

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

Returns
Timestamp of the first received packet in nanoseconds
Example

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

1 $triggerResult Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 21475 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Returns
Timestamp of snapshot in nanoseconds
Example

This example gets the snapshot timestamp [NS].

1 $triggerResult Timestamp.Get

Returns:

1413475070000000000 

Definition at line 21487 of file api.tcl.

Rx.Trigger.Basic.ResultSnapshot::Timestamp.Last.Get

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

Example

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

1 $triggerResult Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 21497 of file api.tcl.