All Classes Namespaces Files Functions Pages
Layer5.Http.ResultData Class Reference

Contains the 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 of this interval in nanoseconds. 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.
 
 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 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 the HTTP result counters.

Definition at line 15541 of file api.tcl.

Method documentation

Layer5.Http.ResultData::AverageDataSpeed.Get

Rate in bytes per seconds of the data transferred.

This method determines the direction of the traffic based on the HTTP method and whether the parent is an HTTPServer or HTTPClient.

A "GET" request on an HTTPServer : TX traffic.A "GET" request on an HTTPClient : RX traffic.A "PUT" request on an HTTPServer : RX traffic.A "PUT" request on an HTTPClient : TX traffic.

Returns
Rate in bytes per second
Example
1 $result AverageDataSpeed.Get

Returns:

949021919 

Definition at line 15557 of file api.tcl.

Layer5.Http.ResultData::Interval.Duration.Get

Returns the duration of this interval in nanoseconds.

Returns
intervalduration in nanoseconds
Example
1 $result Interval.Duration.Get

Returns:

1000000000 

Definition at line 15574 of file api.tcl.

Layer5.Http.ResultData::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 $result Rx.ByteCount.Header.Get

Returns:

19 

Definition at line 15611 of file api.tcl.

Layer5.Http.ResultData::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 $result Rx.ByteCount.Payload.Get

Returns:

949021900 

Definition at line 15623 of file api.tcl.

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

Rate in bytes per seconds of the data received.

Returns
Rate in bytes per second
Example
1 $result Rx.ByteCount.Rate.Get

Returns:

949021919 

Definition at line 15635 of file api.tcl.

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

Total of bytes received.

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

Returns
Total received bytes
Example
1 $result Rx.ByteCount.Total.Get

Returns:

949021919 

Definition at line 15649 of file api.tcl.

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

Timestamp (in nanoseconds) of first received packet.

Returns
Timestamp in nanoseconds
Example
1 $result Rx.Timestamp.First.Get

Returns:

1465221151443853228 

Definition at line 15661 of file api.tcl.

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

Timestamp (in nanoseconds) of last received packet.

Returns
Timestamp in nanoseconds
Example
1 $result Rx.Timestamp.Last.Get

Returns:

1465221150060947487 

Definition at line 15673 of file api.tcl.

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

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

The size of the transmitted HTTPHeader in bytes.

Example
1 $result Tx.ByteCount.Header.Get

Returns:

83 

Definition at line 15695 of file api.tcl.

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

The size of the transmitted HTTPPayload in bytes.

Example
1 $result Tx.ByteCount.Payload.Get

Returns:

0 

Definition at line 15705 of file api.tcl.

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

Rate in bytes per seconds of the data sent.

Returns
Rate in bytes per second
Example
1 $result Tx.ByteCount.Rate.Get

Returns:

949021919 

Definition at line 15717 of file api.tcl.

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

Total of transmitted bytes.

Example
1 $result Tx.ByteCount.Total.Get

Returns:

83 

Definition at line 15727 of file api.tcl.

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

Timestamp (in nanoseconds) of first transmitted packet.

Returns
Timestamp in nanoseconds
Example
1 $result Tx.Timestamp.First.Get

Returns:

1465221150061048163 

Definition at line 15739 of file api.tcl.

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

Timestamp (in nanoseconds) of last transmitted packet.

Returns
Timestamp in nanoseconds
Example
1 $result Tx.Timestamp.Last.Get

Returns:

1465221150060947487 

Definition at line 15751 of file api.tcl.