Refreshable snapshot that 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 duration (in nanoseconds) between snapshot objects. More...

	Parent.Get
	Returns the parent object.

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

	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

Refreshable snapshot that contains the result counters for Http.MultiClient or Http.MultiServer.

You can refresh the counters by calling the Layer5.Http.MultiResultSnapshot::Refresh method.

Definition at line 14851 of file api.tcl.

Method documentation

Layer5.Http.MultiResultSnapshot::Connections.Aborted.Get

Returns the number of aborted TCP connection attempts.

Example

1 $result Connections.Aborted.Get

Returns:

Definition at line 14861 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

1 $result Connections.Attempted.Get

Returns:

Definition at line 14873 of file api.tcl.

Layer5.Http.MultiResultSnapshot::Connections.Established.Get

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

Example

1 $result Connections.Established.Get

Returns:

Definition at line 14883 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

1 $result Connections.Refused.Get

Returns:

Definition at line 14895 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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 14905 of file api.tcl.

Layer5.Http.MultiResultSnapshot::DebugCounters.Names.Get

Returns a list of debug counter names.

Note: The list of names is not backwards compatible.

Definition at line 14913 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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 14928 of file api.tcl.

Layer5.Http.MultiResultSnapshot::Interval.Duration.Get

Returns the duration (in nanoseconds) between snapshot objects.

Example

1 set result [ $HTTPMultiClientClientSessionInfo Result.Get]

2 $result Interval.Duration.Get

Returns:

1000000000

Definition at line 14939 of file api.tcl.

Layer5.Http.MultiResultSnapshot::Refresh

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

Example

1 set result [ $HTTPMultiClientClientSessionInfo Result.Get]

2 $result Refresh

Definition at line 14967 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

1 $HTTPMultiClientClientSessionInfo Refresh.Timestamp.Get

Returns:

1432805398000000000

Definition at line 14956 of file api.tcl.

Layer5.Http.MultiResultSnapshot::RoundTripTime.Average.Get

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

Example

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

Returns:

Definition at line 14983 of file api.tcl.

Layer5.Http.MultiResultSnapshot::RoundTripTime.Maximum.Get

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

Example

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

Returns:

Definition at line 14993 of file api.tcl.

Layer5.Http.MultiResultSnapshot::RoundTripTime.Minimum.Get

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

Example

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

Returns:

Definition at line 15003 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

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

Returns:

1465221151443853228

Definition at line 15027 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

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

Returns:

1465221151443853228

Definition at line 15039 of file api.tcl.

Layer5.Http.MultiResultSnapshot::Sessions.Aborted.Get

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

Example

1 $result Sessions.Aborted.Get

Returns:

Definition at line 15049 of file api.tcl.

Layer5.Http.MultiResultSnapshot::Sessions.Finished.Get

Returns the number HTTP requests that finished succesfully.

Example

1 $result Sessions.Finished.Get

Returns:

Definition at line 15059 of file api.tcl.

Layer5.Http.MultiResultSnapshot::Sessions.ResetByPeer.Get

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

Example

1 $result Sessions.ResetByPeer.Get

Returns:

Definition at line 15069 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

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

Returns:

1465221151443853228

Definition at line 15093 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

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

Returns:

1465221151443853228

Definition at line 15105 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

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

Returns:

1465221151443853228

Definition at line 15129 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

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

Returns:

1465221151443853228

Definition at line 15141 of file api.tcl.

Layer5.Http.MultiResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Returns: Timestamp of snapshot in nanoseconds

Example

This example gets the snapshot timestamp [NS].

1 $result Timestamp.Get

Returns:

1413475070000000000

Definition at line 15153 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

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

Returns:

1465221151443853228

Definition at line 15177 of file api.tcl.

Layer5.Http.MultiResultSnapshot::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

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

Returns:

1465221151443853228

Definition at line 15189 of file api.tcl.

Methods

Class overview

Method documentation