Layer4.Tcp.ResultSnapshot Class Reference

Contains 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...
	Refresh.Timestamp.Get
	Returns the timestamp when the counters of this object where last refreshed. More...
	Refresh
	Updates the snapshot with the most recent results from the ByteBlower server. 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 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 TCP result counters.

You can refresh the counters by calling the Layer4.Tcp.ResultSnapshot::Refresh method.

Definition at line 9894 of file api.tcl.

Method documentation

Layer4.Tcp.ResultSnapshot::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 9907 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 9920 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 9933 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 9951 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 9964 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 9977 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 9988 of file api.tcl.

Layer4.Tcp.ResultSnapshot::NumberOfFinReceived.Get

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

Example

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

Returns:

1 

Definition at line 9999 of file api.tcl.

Layer4.Tcp.ResultSnapshot::NumberOfFinSent.Get

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

Example

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

Returns:

1 

Definition at line 10010 of file api.tcl.

Layer4.Tcp.ResultSnapshot::NumberOfSynReceived.Get

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

Example

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

Returns:

1 

Definition at line 10021 of file api.tcl.

Layer4.Tcp.ResultSnapshot::NumberOfSynSent.Get

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

Example

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

Returns:

1 

Definition at line 10032 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10050 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10063 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10076 of file api.tcl.

Layer4.Tcp.ResultSnapshot::Refresh

Updates the snapshot with the most recent results from the ByteBlower server.

Example

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

Definition at line 10099 of file api.tcl.

Layer4.Tcp.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

Example

$tcpSessionInfo Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 10088 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10110 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10121 of file api.tcl.

Layer4.Tcp.ResultSnapshot::RetransmissionCount.Total.Get

Returns the total number of retranmissions.

Example

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

Returns:

0 

Definition at line 10132 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10143 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10156 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10167 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10178 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10189 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10200 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10213 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10236 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10247 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10258 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10271 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10284 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10297 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10308 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10319 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10330 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10341 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10352 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10363 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10374 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10385 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10398 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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 10409 of file api.tcl.

Layer4.Tcp.ResultSnapshot::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:

1432050455066831988 

Definition at line 10420 of file api.tcl.