Contains HTTP result counters. More...

Methods
	AverageDataSpeed.Get
	Rate in bytes per seconds of the data transferred. More...

	Description.Get
	Returns a textual description of the object.

	Interval.Duration.Get
	Returns the duration (in nanoseconds) between snapshot objects. More...

	Jitter.Get

	Latency.Average.Get
	TODO: FR: HTTP Latency: documentation (also document default_value)

	Latency.Maximum.Get

	Latency.Minimum.Get

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

	Rx.ByteCount.Header.Get
	The size of the received HTTPheader in bytes. More...

	Rx.ByteCount.Payload.Get
	The size of the received HTTP Payload in bytes. More...

	Rx.ByteCount.Rate.Get
	Rate in bytes per seconds of the data received. More...

	Rx.ByteCount.Total.Get
	Total number of bytes received. More...

	Rx.Timestamp.First.Get
	Timestamp (in nanoseconds) of first received packet. More...

	Rx.Timestamp.Last.Get
	Timestamp (in nanoseconds) of last received packet. More...

	Timestamp.Get
	Gets the snapshot timestamp [NS]. More...

	Tx.ByteCount.Header.Get
	The size of the transmitted HTTPHeader in bytes. More...

	Tx.ByteCount.Payload.Get
	The size of the transmitted HTTPPayload in bytes. More...

	Tx.ByteCount.Rate.Get
	Rate in bytes per seconds of the data sent. More...

	Tx.ByteCount.Total.Get
	Total of transmitted bytes. More...

	Tx.Timestamp.First.Get
	Timestamp (in nanoseconds) of first transmitted packet. More...

	Tx.Timestamp.Last.Get
	Timestamp (in nanoseconds) of last transmitted packet. More...

Class overview

Contains HTTP result counters.

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

Definition at line 15987 of file api.tcl.

Method documentation

Layer5.Http.ResultSnapshot::AverageDataSpeed.Get

Rate in bytes per seconds of the data transferred.

Depending on the HTTP method or if the parent of this object is an HTTPServer or HTTPClient, the rate of the traffic sent or received will be returned

Returns: Rate in bytes per second

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result AverageDataSpeed.Get

Returns:

949021919

Definition at line 16002 of file api.tcl.

Layer5.Http.ResultSnapshot::Interval.Duration.Get

Returns the duration (in nanoseconds) between snapshot objects.

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Interval.Duration.Get

Returns:

1000000000

Definition at line 16018 of file api.tcl.

Layer5.Http.ResultSnapshot::Refresh

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

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Refresh

Definition at line 16066 of file api.tcl.

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

1 $httpClientSessionInfo Refresh.Timestamp.Get

Returns:

1432805398000000000

Definition at line 16055 of file api.tcl.

Layer5.Http.ResultSnapshot::Rx.ByteCount.Header.Get

The size of the received HTTPheader in bytes.

HTTP header contains the HTTP header fields. These fields define the operating parameters of an HTTP transaction (e.g. : User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0 )

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Rx.ByteCount.Header.Get

Returns:

Definition at line 16079 of file api.tcl.

Layer5.Http.ResultSnapshot::Rx.ByteCount.Payload.Get

The size of the received HTTP Payload in bytes.

The size of the actual content of the HTTP transaction

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Rx.ByteCount.Payload.Get

Returns:

949021900

Definition at line 16092 of file api.tcl.

Layer5.Http.ResultSnapshot::Rx.ByteCount.Rate.Get

Rate in bytes per seconds of the data received.

Returns: Rate in bytes per second

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Rx.ByteCount.Rate.Get

Returns:

949021919

Definition at line 16105 of file api.tcl.

Layer5.Http.ResultSnapshot::Rx.ByteCount.Total.Get

Total number of bytes received.

The total is the sum of Rx.ByteCount.Header.Get and Rx.ByteCount.Payload.Get

Returns: Total received bytes

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Rx.ByteCount.Total.Get

Returns:

949021919

Definition at line 16120 of file api.tcl.

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

Timestamp (in nanoseconds) of first received packet.

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Rx.Timestamp.First.Get

Returns:

Definition at line 16131 of file api.tcl.

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

Timestamp (in nanoseconds) of last received packet.

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Rx.Timestamp.Last.Get

Returns:

Definition at line 16142 of file api.tcl.

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

Layer5.Http.ResultSnapshot::Tx.ByteCount.Header.Get

The size of the transmitted HTTPHeader in bytes.

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Tx.ByteCount.Header.Get

Returns:

Definition at line 16165 of file api.tcl.

Layer5.Http.ResultSnapshot::Tx.ByteCount.Payload.Get

The size of the transmitted HTTPPayload in bytes.

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Tx.ByteCount.Payload.Get

Returns:

Definition at line 16176 of file api.tcl.

Layer5.Http.ResultSnapshot::Tx.ByteCount.Rate.Get

Rate in bytes per seconds of the data sent.

Returns: Rate in bytes per second

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Tx.ByteCount.Rate.Get

Returns:

949021919

Definition at line 16189 of file api.tcl.

Layer5.Http.ResultSnapshot::Tx.ByteCount.Total.Get

Total of transmitted bytes.

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Tx.ByteCount.Total.Get

Returns:

Definition at line 16200 of file api.tcl.

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

Timestamp (in nanoseconds) of first transmitted packet.

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Tx.Timestamp.First.Get

Returns:

Definition at line 16211 of file api.tcl.

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

Timestamp (in nanoseconds) of last transmitted packet.

Example

1 set result [ $httpClientSessionInfo Result.Get]

2 $result Tx.Timestamp.Last.Get

Returns:

Definition at line 16222 of file api.tcl.

Methods

Class overview

Method documentation