All Classes Namespaces Files Functions Pages
Layer4.Tcp.SessionInfo Class Reference

Class containing info about the TCP session. More...

Methods

 CongestionAvoidanceAlgorithm.Get
 Returns the congestion avoidance algorithm used in this TCP session. More...
 
 ConnectionState.Get
 Returns the current TCP connection state. More...
 
 Description.Get
 Returns a textual description of the object.
 
 MaximumSegmentSize.Get
 Returns the maximum segment size this TCP connection is allowed to use when transmitting data.. More...
 
 Parent.Get
 Returns the parent object.
 
 Prague.IsEnabled
 Returns whether TCP Prague was succesfully negotiated or not.
 
 Result.Get
 Returns the Layer4.Tcp.ResultSnapshot for this session containing the current result counters. More...
 
 Result.History.Get
 Returns the Layer4.Tcp.ResultHistory for this session. More...
 

Class overview

Class containing info about the TCP session.

Definition at line 10428 of file api.tcl.

Method documentation

Layer4.Tcp.SessionInfo::CongestionAvoidanceAlgorithm.Get

Returns the congestion avoidance algorithm used in this TCP session.

Returns
CongestionAvoidanceAlgorithm Possible values are:
  • Sack
  • None
  • NewReno
  • ServerDefault
Example
1 set tcpSessionInfo [ $httpClientSessionInfo Tcp.Session.Info.Get ]
2  $tcpSessionInfo CongenstionAvoidanceAlgorithm.Get

Returns:

Sack 

Definition at line 10441 of file api.tcl.

Layer4.Tcp.SessionInfo::ConnectionState.Get

Returns the current TCP connection state.

Returns
TCP ConnectionState Possible values are:
  • LISTEN
  • SYN_SENT
  • SYN_RECEIVED
  • ESTABLISHED
  • FIN_WAIT_1
  • FIN_WAIT_2
  • CLOSE_WAIT
  • CLOSING
  • LAST_ACK
  • TIME_WAIT
  • CLOSED
Example
1 set tcpSessionInfo [ $httpClientSessionInfo Tcp.Session.Info.Get ]
2  $tcpSessionInfo ConnectionState.Get

Returns:

TIME_WAIT 

Definition at line 10454 of file api.tcl.

Layer4.Tcp.SessionInfo::MaximumSegmentSize.Get

Returns the maximum segment size this TCP connection is allowed to use when transmitting data..

Example
1 set tcpSessionInfo [ $httpClientSessionInfo Tcp.Session.Info.Get ]
2  $tcpSessionInfo MaximumSegmentSize.Get

Returns:

1460 

Definition at line 10470 of file api.tcl.

Layer4.Tcp.SessionInfo::Result.Get

Returns the Layer4.Tcp.ResultSnapshot for this session containing the current result counters.

The snapshot contains byte counters and time values.

Returns
Layer4.Tcp.ResultSnapshot
Example
1 $tcpClient Result.Get

Returns:

<Layer5.Tcp.ResultSnapshot object> 

Definition at line 10495 of file api.tcl.

Layer4.Tcp.SessionInfo::Result.History.Get

Returns the Layer4.Tcp.ResultHistory for this session.

Returns
Layer4.Tcp.ResultHistory
Example
1 $tcpClient Result.History.Get

Returns:

<Layer4.Tcp.ResultHistory object> 

Definition at line 10507 of file api.tcl.