Layer4.Tcp.ResultData Class Reference

Contains static TCP result counters. More...

Methods
	CongestionWindow.Current.Get
	Returns the current TCP congestion window (CWND). More...
	CongestionWindow.Maximum.Get
	Returns the largest recorded TCP congestion window (CWND). More...
	CongestionWindow.Minimum.Get
	Returns the smallest recorded TCP congestion window (CWND). More...
	Description.Get
	Returns a textual description of the object.
	FlightSize.Current.Get
	Returns the number of bytes that are currently in-flight. More...
	FlightSize.Maximum.Get
	Returns the largest recorded flight-size. More...
	FlightSize.Minimum.Get
	Returns the smallest recorded flight-size. More...
	Interval.Duration.Get
	Returns nanosecond duration between when result objects are created. More...
	NumberOfFinReceived.Get
	Returns the number of TCP FIN segments that have been received. More...
	NumberOfFinSent.Get
	Returns the number of TCP FIN segments that have been sent. More...
	NumberOfSynReceived.Get
	Returns the number of TCP SYN segments that have been received. More...
	NumberOfSynSent.Get
	Returns the number of TCP SYN segments that have been sent. More...
	Parent.Get
	Returns the parent object.
	ReceiverWindow.Current.Get
	Returns the current TCP receiver window (RWND). More...
	ReceiverWindow.Maximum.Get
	Returns the largest recorded TCP receiver window (RWND). More...
	ReceiverWindow.Minimum.Get
	Returns the smallest recorded TCP receiver window (RWND). More...
	RetransmissionCount.Fast.Get
	Returns the total number of fast retranmissions. More...
	RetransmissionCount.Slow.Get
	Returns the total number of timeout retranmissions. More...
	RetransmissionCount.Total.Get
	Returns the total number of retranmissions. More...
	RoundTripTime.Average.Get
	Returns the average round-trip time (RTT) in nanoseconds. More...
	RoundTripTime.Current.Get
	Returns the current round-trip time (RTT) in nanoseconds. More...
	RoundTripTime.Maximum.Get
	Returns the largest recorded round-trip time (RTT) in nanoseconds. More...
	RoundTripTime.Minimum.Get
	Returns the smallest recorded round-trip time (RTT) in nanoseconds. More...
	Rx.ByteCount.Header.Get
	Returns the number of received TCP header bytes. More...
	Rx.ByteCount.Payload.Get
	Returns the number of received TCP payload bytes. More...
	Rx.ByteCount.Total.Get
	Returns the total number of bytes received on the current TCP connection. More...
	Rx.LocalCongestionNotificationCount.Get
	Returns the number of segments received with an explicit congestion notification.
	Rx.RemoteCongestionNotificationCount.Get
	Returns the number of explicit congestion notifications received by the other side of the connection.
	Rx.SegmentCount.OutOfOrder.Get
	Returns the number of segments that were received out of order. More...
	Rx.SegmentCount.Total.Get
	Returns the total number of received segments. More...
	Rx.Timestamp.Last.Get
	Returns a nanosecond timestamp for when this TCP connection received its last TCP segment. More...
	SlowStartThreshold.Current.Get
	Returns the current TCP slow-start threshold (SSTHRESH). More...
	SlowStartThreshold.Maximum.Get
	Returns the largest recorded TCP slow-start threshold (SSTHRESH). More...
	SlowStartThreshold.Minimum.Get
	Returns the smallest recorded TCP slow-start threshold (SSTHRESH). More...
	Timestamp.Established.Get
	Returns a nanosecond timestamp for when this TCP connection entered the established state. More...
	Timestamp.FinReceived.Get
	Returns a nanosecond timestamp for when this TCP connection received the TCP-FIN segment. More...
	Timestamp.FinSent.Get
	Returns a nanosecond timestamp for when this TCP connection sent the TCP-FIN segment. More...
	Timestamp.Get
	Returns the nanosecond timestamp for when this result object was created. More...
	Timestamp.SynReceived.Get
	Returns a nanosecond timestamp for when this TCP connection received the TCP-SYN segment. More...
	Timestamp.SynSent.Get
	Returns a nanosecond timestamp for when this TCP connection sent the TCP-SYN segment. More...
	Tx.ByteCount.Header.Get
	Returns the number of transmitted TCP header bytes. More...
	Tx.ByteCount.Payload.Get
	Returns the number of transmitted TCP payload bytes. More...
	Tx.ByteCount.Total.Get
	Returns the total number of bytes transmitted on the current TCP connection. More...
	Tx.SegmentCount.Total.Get
	Returns the total number of transmitted segments. More...
	Tx.Timestamp.Last.Get
	Returns a nanosecond timestamp for when this TCP connection sent its last TCP segment. More...

Class overview

Contains static TCP result counters.

Definition at line 9113 of file api.tcl.

Method documentation

Layer4.Tcp.ResultData::CongestionWindow.Current.Get

Returns the current TCP congestion window (CWND).

The congestion window is the maximum number of bytes that we are allowed to send before receiving a new TCP ACK.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result CongestionWindow.Current.Get

Returns:

3004 

Definition at line 9126 of file api.tcl.

Layer4.Tcp.ResultData::CongestionWindow.Maximum.Get

Returns the largest recorded TCP congestion window (CWND).

The congestion window is the maximum number of bytes that we are allowed to send before receiving a new TCP ACK.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result CongestionWindow.Maximum.Get

Returns:

3004 

Definition at line 9139 of file api.tcl.

Layer4.Tcp.ResultData::CongestionWindow.Minimum.Get

Returns the smallest recorded TCP congestion window (CWND).

The congestion window is the maximum number of bytes that we are allowed to send before receiving a new TCP ACK.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result CongestionWindow.Minimum.Get

Returns:

2920 

Definition at line 9152 of file api.tcl.

Layer4.Tcp.ResultData::FlightSize.Current.Get

Returns the number of bytes that are currently in-flight.

The flight size is the number of bytes that has been transmitted but not yet acknowledged.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result FlightSize.Current.Get

Returns:

Definition at line 9170 of file api.tcl.

Layer4.Tcp.ResultData::FlightSize.Maximum.Get

Returns the largest recorded flight-size.

The flight size is the number of bytes that has been transmitted but not yet acknowledged.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result FlightSize.Maximum.Get

Returns:

0 

Definition at line 9183 of file api.tcl.

Layer4.Tcp.ResultData::FlightSize.Minimum.Get

Returns the smallest recorded flight-size.

The flight size is the number of bytes that has been transmitted but not yet acknowledged.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result FlightSize.Minimum.Get

Returns:

Definition at line 9196 of file api.tcl.

Layer4.Tcp.ResultData::Interval.Duration.Get

Returns nanosecond duration between when result objects are created.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Interval.Duration.Get

Returns:

1000000000 

Definition at line 9207 of file api.tcl.

Layer4.Tcp.ResultData::NumberOfFinReceived.Get

Returns the number of TCP FIN segments that have been received.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result NumberOfFinReceived.Get

Returns:

1432050455066831988 

Definition at line 9218 of file api.tcl.

Layer4.Tcp.ResultData::NumberOfFinSent.Get

Returns the number of TCP FIN segments that have been sent.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result NumberOfFinSent.Get

Returns:

1432050455066831988 

Definition at line 9229 of file api.tcl.

Layer4.Tcp.ResultData::NumberOfSynReceived.Get

Returns the number of TCP SYN segments that have been received.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result NumberOfSynReceived.Get

Returns:

1432050455066831988 

Definition at line 9240 of file api.tcl.

Layer4.Tcp.ResultData::NumberOfSynSent.Get

Returns the number of TCP SYN segments that have been sent.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result NumberOfSynSent.Get

Returns:

1432050455066831988 

Definition at line 9251 of file api.tcl.

Layer4.Tcp.ResultData::ReceiverWindow.Current.Get

Returns the current TCP receiver window (RWND).

The receiver window is the maximum number of bytes that the remote connection is currently able to receive.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result ReceiverWindow.Current.Get

Returns:

524280 

Definition at line 9269 of file api.tcl.

Layer4.Tcp.ResultData::ReceiverWindow.Maximum.Get

Returns the largest recorded TCP receiver window (RWND).

The receiver window is the maximum number of bytes that the remote connection is currently able to receive.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result ReceiverWindow.Maximum.Get

Returns:

524280 

Definition at line 9282 of file api.tcl.

Layer4.Tcp.ResultData::ReceiverWindow.Minimum.Get

Returns the smallest recorded TCP receiver window (RWND).

The receiver window is the maximum number of bytes that the remote connection is currently able to receive.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result ReceiverWindow.Minimum.Get

Returns:

524280 

Definition at line 9295 of file api.tcl.

Layer4.Tcp.ResultData::RetransmissionCount.Fast.Get

Returns the total number of fast retranmissions.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result RetransmissionCount.Fast.Get

Returns:

0 

Definition at line 9306 of file api.tcl.

Layer4.Tcp.ResultData::RetransmissionCount.Slow.Get

Returns the total number of timeout retranmissions.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result RetransmissionCount.Slow.Get

Returns:

0 

Definition at line 9317 of file api.tcl.

Layer4.Tcp.ResultData::RetransmissionCount.Total.Get

Returns the total number of retranmissions.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result RetransmissionCount.Total.Get

Returns:

0 

Definition at line 9328 of file api.tcl.

Layer4.Tcp.ResultData::RoundTripTime.Average.Get

Returns the average round-trip time (RTT) in nanoseconds.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result RoundTripTime.Average.Get

Returns:

2917720 

Definition at line 9339 of file api.tcl.

Layer4.Tcp.ResultData::RoundTripTime.Current.Get

Returns the current round-trip time (RTT) in nanoseconds.

Deprecated:

This method has been deprecated because it does not provide a useful metric. Please use RoundTripTime.Average.Get .

Example

set result [ $tcpSessionInfo Result.Get]  
 $result RoundTripTime.Current.Get

Returns:

2917720 

Definition at line 9352 of file api.tcl.

Layer4.Tcp.ResultData::RoundTripTime.Maximum.Get

Returns the largest recorded round-trip time (RTT) in nanoseconds.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result RoundTripTime.Maximum.Get

Returns:

2972548 

Definition at line 9363 of file api.tcl.

Layer4.Tcp.ResultData::RoundTripTime.Minimum.Get

Returns the smallest recorded round-trip time (RTT) in nanoseconds.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result RoundTripTime.Minimum.Get

Returns:

2972548 

Definition at line 9374 of file api.tcl.

Layer4.Tcp.ResultData::Rx.ByteCount.Header.Get

Returns the number of received TCP header bytes.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Rx.ByteCount.Header.Get

Returns:

12939992 

Definition at line 9385 of file api.tcl.

Layer4.Tcp.ResultData::Rx.ByteCount.Payload.Get

Returns the number of received TCP payload bytes.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Rx.ByteCount.Payload.Get

Returns:

944612719 

Definition at line 9396 of file api.tcl.

Layer4.Tcp.ResultData::Rx.ByteCount.Total.Get

Returns the total number of bytes received on the current TCP connection.

This is the sum of the received TCP header and payload bytes.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Rx.ByteCount.Total.Get

Returns:

957552711 

Definition at line 9409 of file api.tcl.

Layer4.Tcp.ResultData::Rx.SegmentCount.OutOfOrder.Get

Returns the number of segments that were received out of order.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Rx.SegmentCount.OutOfOrder.Get

Returns:

0 

there where 0 segments received out of order

Definition at line 9432 of file api.tcl.

Layer4.Tcp.ResultData::Rx.SegmentCount.Total.Get

Returns the total number of received segments.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Rx.SegmentCount.Total.Get

Returns:

646999 

this session received 646999 TCP segments

Definition at line 9443 of file api.tcl.

Layer4.Tcp.ResultData::Rx.Timestamp.Last.Get

Returns a nanosecond timestamp for when this TCP connection received its last TCP segment.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Rx.Timestamp.Last.Get

Returns:

1432050455077915111 

Definition at line 9454 of file api.tcl.

Layer4.Tcp.ResultData::SlowStartThreshold.Current.Get

Returns the current TCP slow-start threshold (SSTHRESH).

The slow-start threshold indicates the congestion window value where the congestion avoidance algorithm switches from "slow-start"-mode to "congestion-avoidance"-mode.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result SlowStartThreshold.Current.Get

Returns:

Definition at line 9467 of file api.tcl.

Layer4.Tcp.ResultData::SlowStartThreshold.Maximum.Get

Returns the largest recorded TCP slow-start threshold (SSTHRESH).

The slow-start threshold indicates the congestion window value where the congestion avoidance algorithm switches from "slow-start"-mode to "congestion-avoidance"-mode.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result SlowStartThreshold.Maximum.Get

Returns:

Definition at line 9480 of file api.tcl.

Layer4.Tcp.ResultData::SlowStartThreshold.Minimum.Get

Returns the smallest recorded TCP slow-start threshold (SSTHRESH).

The slow-start threshold indicates the congestion window value where the congestion avoidance algorithm switches from "slow-start"-mode to "congestion-avoidance"-mode.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result SlowStartThreshold.Minimum.Get

Returns:

Definition at line 9493 of file api.tcl.

Layer4.Tcp.ResultData::Timestamp.Established.Get

Returns a nanosecond timestamp for when this TCP connection entered the established state.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Timestamp.Established.Get

Returns:

1432050394978590842 

Definition at line 9504 of file api.tcl.

Layer4.Tcp.ResultData::Timestamp.FinReceived.Get

Returns a nanosecond timestamp for when this TCP connection received the TCP-FIN segment.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Timestamp.FinReceived.Get

Returns:

1432050455066831988 

Definition at line 9515 of file api.tcl.

Layer4.Tcp.ResultData::Timestamp.FinSent.Get

Returns a nanosecond timestamp for when this TCP connection sent the TCP-FIN segment.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Timestamp.FinSent.Get

Returns:

1432050455066849650 

Definition at line 9526 of file api.tcl.

Layer4.Tcp.ResultData::Timestamp.Get

Returns the nanosecond timestamp for when this result object was created.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Timestamp.Get

Returns:

1432050751000000000 

Definition at line 9537 of file api.tcl.

Layer4.Tcp.ResultData::Timestamp.SynReceived.Get

Returns a nanosecond timestamp for when this TCP connection received the TCP-SYN segment.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Timestamp.SynReceived.Get

Returns:

1432050394978573390 

Definition at line 9548 of file api.tcl.

Layer4.Tcp.ResultData::Timestamp.SynSent.Get

Returns a nanosecond timestamp for when this TCP connection sent the TCP-SYN segment.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Timestamp.SynSent.Get

Returns:

1432050394962049266 

Definition at line 9559 of file api.tcl.

Layer4.Tcp.ResultData::Tx.ByteCount.Header.Get

Returns the number of transmitted TCP header bytes.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Tx.ByteCount.Header.Get

Returns:

6942932 

this session transmitted in total 6942932 bytes of TCP headers

Definition at line 9570 of file api.tcl.

Layer4.Tcp.ResultData::Tx.ByteCount.Payload.Get

Returns the number of transmitted TCP payload bytes.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Tx.ByteCount.Header.Get

Returns:

84 

this session transmitted in total 84 bytes of TCP Payload we can conclude that this was a receiver of the TCP bytes

Definition at line 9581 of file api.tcl.

Layer4.Tcp.ResultData::Tx.ByteCount.Total.Get

Returns the total number of bytes transmitted on the current TCP connection.

This is the sum of the tranmitted TCP header and payload bytes.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Tx.ByteCount.Total.Get

Returns:

6943016 

this session transmitted 6943016 bytes of TCP

Definition at line 9594 of file api.tcl.

Layer4.Tcp.ResultData::Tx.SegmentCount.Total.Get

Returns the total number of transmitted segments.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Tx.SegmentCount.Total.Get

Returns:

347146 

this session transmitted 347146 TCP segments

Definition at line 9605 of file api.tcl.

Layer4.Tcp.ResultData::Tx.Timestamp.Last.Get

Returns a nanosecond timestamp for when this TCP connection sent its last TCP segment.

Example

set result [ $tcpSessionInfo Result.Get]  
 $result Tx.Timestamp.Last.Get

Returns:

1432050751489138284 

Definition at line 9616 of file api.tcl.