Layer5.Http.MultiResultData Class Reference

Contains the result counters for Http.MultiClient or Http.MultiServer. More...

Methods
	Connections.Aborted.Get
	Returns the number of aborted TCP connection attempts. More...
	Connections.Attempted.Get
	Returns the number of TCP connection attempts that were initiated. More...
	Connections.Established.Get
	Returns the number of succesful TCP connection attempts that reached ESTABLISHED state. More...
	Connections.Refused.Get
	Returns the number of TCP connection attempts that were refused by the other side. More...
	DebugCounters.GetByName name
	Returns a list of debug counter values. More...
	DebugCounters.Names.Get
	Returns a list of debug counter names. More...
	Description.Get
	Returns a textual description of the object.
	Finished.Get
	Indicates whether the flow has finished. More...
	Interval.Duration.Get
	Returns the snapshot duration interval in nanoseconds. More...
	Parent.Get
	Returns the parent object.
	Retransmissions.Get
	Returns number of TCP retransmissions.
	RoundTripTime.Average.Get
	Returns average TCP round-trip time or a default value in case no round-trip samples are available. More...
	RoundTripTime.Maximum.Get
	Returns maximum TCP round-trip time or a default value in case no round-trip samples are available. More...
	RoundTripTime.Minimum.Get
	Returns minimum TCP round-trip time or a default value in case no round-trip samples are available. More...
	Rx.ByteCount.Get
	Returns number of received bytes.
	Rx.Speed.Mbps.Get
	Returns average Rx speed in megabit per second.
	Rx.Timestamp.First.Get
	Returns the timestamp (in nanoseconds) of the first receieved packet or a default value in case no packets were received. More...
	Rx.Timestamp.Last.Get
	Returns the timestamp (in nanoseconds) of the last receieved packet or a default value in case no packets were received. More...
	Sessions.Aborted.Get
	Returns the number HTTP requests that failed because they were aborted locally. More...
	Sessions.Finished.Get
	Returns the number HTTP requests that finished succesfully. More...
	Sessions.ResetByPeer.Get
	Returns the number HTTP requests that failed because a TCP RESET message was received. More...
	Tcp.Rx.ByteCount.Get
	Returns number of bytes received by the TCP protocol. This includes the TCP header.
	Tcp.Rx.SegmentCount.Get
	Returns number of packets received by the TCP protocol.
	Tcp.Rx.Timestamp.First.Get
	Returns the timestamp (in nanoseconds) of the first receieved TCP segment or a default value in case no packets were received. More...
	Tcp.Rx.Timestamp.Last.Get
	Returns the timestamp (in nanoseconds) of the last receieved TCP segment or a default value in case no packets were received. More...
	Tcp.Tx.ByteCount.Get
	Returns number of bytes sent by the TCP protocol. This includes the TCP header and TCP retransmissions.
	Tcp.Tx.SegmentCount.Get
	Returns number of packets sent by the TCP protocol.
	Tcp.Tx.Timestamp.First.Get
	Returns the timestamp (in nanoseconds) of the first transmitted TCP segment or a default value in case no packets were transmitted. More...
	Tcp.Tx.Timestamp.Last.Get
	Returns the timestamp (in nanoseconds) of the last transmitted TCP segment or a default value in case no packets were transmitted. More...
	Timestamp.Get
	Gets the snapshot timestamp [NS]. More...
	Tx.ByteCount.Get
	Returns number of sent bytes.
	Tx.Speed.Mbps.Get
	Returns average Tx speed in megabit per second.
	Tx.Timestamp.First.Get
	Returns the timestamp (in nanoseconds) of the first transmitted packet or a default value in case no packets were transmitted. More...
	Tx.Timestamp.Last.Get
	Returns the timestamp (in nanoseconds) of the last transmitted packet or a default value in case no packets were transmitted. More...

Class overview

Contains the result counters for Http.MultiClient or Http.MultiServer.

Definition at line 14349 of file api.tcl.

Method documentation

Layer5.Http.MultiResultData::Connections.Aborted.Get

Returns the number of aborted TCP connection attempts.

Example

$result Connections.Aborted.Get

Returns:

10 

Definition at line 14359 of file api.tcl.

Layer5.Http.MultiResultData::Connections.Attempted.Get

Returns the number of TCP connection attempts that were initiated.

For the Layer5.Http.MultiClient this means the number of active TCP connection attempts initiated. For the Layer5.Http.MultiServer this means the number of passive TCP connection requests received.

Example

$result Connections.Attempted.Get

Returns:

10 

Definition at line 14371 of file api.tcl.

Layer5.Http.MultiResultData::Connections.Established.Get

Returns the number of succesful TCP connection attempts that reached ESTABLISHED state.

Example

$result Connections.Established.Get

Returns:

10 

Definition at line 14381 of file api.tcl.

Layer5.Http.MultiResultData::Connections.Refused.Get

Returns the number of TCP connection attempts that were refused by the other side.

For the Layer5.Http.MultiServer this value is always zero.

Example

$result Connections.Refused.Get

Returns:

10 

Definition at line 14393 of file api.tcl.

Layer5.Http.MultiResultData::DebugCounters.GetByName			name

Returns a list of debug counter values.

Note

The list of debug values is not backwards compatible.

Parameters

name	The name of the debug counter (obtained from Layer5.Http.MultiResultData::DebugCounters.Names.Get).

Definition at line 14403 of file api.tcl.

Layer5.Http.MultiResultData::DebugCounters.Names.Get

Returns a list of debug counter names.

Note

The list of names is not backwards compatible.

Definition at line 14411 of file api.tcl.

Layer5.Http.MultiResultData::Finished.Get

Indicates whether the flow has finished.

Returns

Boolean value indiciating if the flow has finished.

For the Layer5.Http.MultiClient this means that client state is Finished or Stopped. For the Layer5.Http.MultiServer this means the server state is Stopped.

Definition at line 14426 of file api.tcl.

Layer5.Http.MultiResultData::Interval.Duration.Get

Returns the snapshot duration interval in nanoseconds.

Returns

intervalduration in nanoseconds

Example

$result Interval.Duration.Get

Returns:

1000000000 

Definition at line 14438 of file api.tcl.

Layer5.Http.MultiResultData::RoundTripTime.Average.Get

Returns average TCP round-trip time or a default value in case no round-trip samples are available.

Example

set rtt_avg [ $result RoundTripTime.Average.Get 0 ]

Returns:

2972548 

Definition at line 14459 of file api.tcl.

Layer5.Http.MultiResultData::RoundTripTime.Maximum.Get

Returns maximum TCP round-trip time or a default value in case no round-trip samples are available.

Example

set rtt_max [ $result RoundTripTime.Maximum.Get 0 ]

Returns:

2972548 

Definition at line 14469 of file api.tcl.

Layer5.Http.MultiResultData::RoundTripTime.Minimum.Get

Returns minimum TCP round-trip time or a default value in case no round-trip samples are available.

Example

set rtt_min [ $result RoundTripTime.Minimum.Get 0 ]

Returns:

2972548 

Definition at line 14479 of file api.tcl.

Layer5.Http.MultiResultData::Rx.Timestamp.First.Get

Returns the timestamp (in nanoseconds) of the first receieved packet or a default value in case no packets were received.

Returns

Timestamp in nanoseconds

Example

Prints -1 if the counter is not available

puts [ $result Rx.Timestamp.First.Get -1 ]

Returns:

1465221151443853228 

Definition at line 14503 of file api.tcl.

Layer5.Http.MultiResultData::Rx.Timestamp.Last.Get

Returns the timestamp (in nanoseconds) of the last receieved packet or a default value in case no packets were received.

Returns

Timestamp in nanoseconds

Example

Prints -1 if the counter is not available

puts [ $result Rx.Timestamp.Last.Get -1 ]

Returns:

1465221151443853228 

Definition at line 14515 of file api.tcl.

Layer5.Http.MultiResultData::Sessions.Aborted.Get

Returns the number HTTP requests that failed because they were aborted locally.

Example

$result Sessions.Aborted.Get

Returns:

10 

Definition at line 14525 of file api.tcl.

Layer5.Http.MultiResultData::Sessions.Finished.Get

Returns the number HTTP requests that finished succesfully.

Example

$result Sessions.Finished.Get

Returns:

10 

Definition at line 14535 of file api.tcl.

Layer5.Http.MultiResultData::Sessions.ResetByPeer.Get

Returns the number HTTP requests that failed because a TCP RESET message was received.

Example

$result Sessions.ResetByPeer.Get

Returns:

10 

Definition at line 14545 of file api.tcl.

Layer5.Http.MultiResultData::Tcp.Rx.Timestamp.First.Get

Returns the timestamp (in nanoseconds) of the first receieved TCP segment or a default value in case no packets were received.

Returns

Timestamp in nanoseconds

Example

Prints -1 if the counter is not available

puts [ $result Tcp.Rx.Timestamp.First.Get -1 ]

Returns:

1465221151443853228 

Definition at line 14569 of file api.tcl.

Layer5.Http.MultiResultData::Tcp.Rx.Timestamp.Last.Get

Returns the timestamp (in nanoseconds) of the last receieved TCP segment or a default value in case no packets were received.

Returns

Timestamp in nanoseconds

Example

Prints -1 if the counter is not available

puts [ $result Tcp.Rx.Timestamp.Last.Get -1 ]

Returns:

1465221151443853228 

Definition at line 14581 of file api.tcl.

Layer5.Http.MultiResultData::Tcp.Tx.Timestamp.First.Get

Returns the timestamp (in nanoseconds) of the first transmitted TCP segment or a default value in case no packets were transmitted.

Returns

Timestamp in nanoseconds

Example

Prints -1 if the counter is not available

puts [ $result Tcp.Tx.Timestamp.First.Get -1 ]

Returns:

1465221151443853228 

Definition at line 14605 of file api.tcl.

Layer5.Http.MultiResultData::Tcp.Tx.Timestamp.Last.Get

Returns the timestamp (in nanoseconds) of the last transmitted TCP segment or a default value in case no packets were transmitted.

Returns

Timestamp in nanoseconds

Example

Prints -1 if the counter is not available.

puts [ $result Tcp.Tx.Timestamp.Last.Get -1 ]

Returns:

1465221151443853228 

Definition at line 14617 of file api.tcl.

Layer5.Http.MultiResultData::Timestamp.Get

Gets the snapshot timestamp [NS].

Returns

Timestamp of snapshot in nanoseconds

Example

This example gets the snapshot timestamp [NS].

$result Timestamp.Get

Returns:

1413475070000000000 

Definition at line 14629 of file api.tcl.

Layer5.Http.MultiResultData::Tx.Timestamp.First.Get

Returns the timestamp (in nanoseconds) of the first transmitted packet or a default value in case no packets were transmitted.

Returns

Timestamp in nanoseconds

Example

Prints -1 if the counter is not available

puts [ $result Tx.Timestamp.First.Get -1 ]

Returns:

1465221151443853228 

Definition at line 14653 of file api.tcl.

Layer5.Http.MultiResultData::Tx.Timestamp.Last.Get

Returns the timestamp (in nanoseconds) of the last transmitted packet or a default value in case no packets were transmitted.

Returns

Timestamp in nanoseconds

Example

Prints -1 if the counter is not available

puts [ $result Tx.Timestamp.Last.Get -1 ]

Returns:

1465221151443853228 

Definition at line 14665 of file api.tcl.