All Classes Namespaces Files Functions Pages
Rx.Trigger.Basic.ResultData 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.
 
 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

Receive-side trigger result set.

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

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

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

Note
The information is not updated until Rx.Trigger.Basic.ResultHistory::Refresh is called
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 resultHistory [ $trigger Result.History.Get ]
5  foreach result [ $resultHistory Result.Cumulative.Get ] {
6  $result PacketCount.Get
7  }

Definition at line 20905 of file api.tcl.

Method documentation

Rx.Trigger.Basic.ResultData::ByteCount.Get

Gets the current received bytes counter.

Example

This example gets the received bytes counter

1 $triggerResult ByteCount.Get

Returns:

100 

Definition at line 20915 of file api.tcl.

Rx.Trigger.Basic.ResultData::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 20934 of file api.tcl.

Rx.Trigger.Basic.ResultData::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 20948 of file api.tcl.

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

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

Returns
Smallest received frame size 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 20962 of file api.tcl.

Rx.Trigger.Basic.ResultData::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 20976 of file api.tcl.

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

1 $triggerResult Interval.Duration.Get

Returns:

1000000000 

Definition at line 20988 of file api.tcl.

Rx.Trigger.Basic.ResultData::PacketCount.Get

Gets the received packet count.

Example

This example gets the received packet counter

1 $triggerResult PacketCount.Get

Returns:

100 

Definition at line 20998 of file api.tcl.

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

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

Exceptions
CounterUnavailableWhen no frames are received, this counter is unavailable
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 21015 of file api.tcl.

Rx.Trigger.Basic.ResultData::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

1 $triggerResult Timestamp.Get

Returns:

1413475070000000000 

Definition at line 21025 of file api.tcl.

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

Gets the current 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 21035 of file api.tcl.