HTTPPerformanceData

java.lang.Object
- com.dkfqs.tools.http.HTTPPerformanceData

public class HTTPPerformanceData
extends java.lang.Object

The measured performance data of a single, successful executed HTTP call.
The method getExecutionTime() returns the measured 'response time'.


 « ------------------------------------------------- <processing time> ----------------------------------------------- »
                                        « ---------- <execution time> ------------------------------------------------ »
 First call or retry: [SSL prepare time][TCP connect time][SSL handshake time]<request send time><response receive time>
 First call or retry: [SSL prepare time][TCP connect time][SSL handshake time]<request header send time>[<request content send time>]<response first byte receive time><response header receive time>[<response content receive time>]
 ^                   ^
 |                   |
 |                   +-- [start retry timestamp]
 |
 +-- start processing timestamp

 [] = optional data, -1 if no such data are measured

See Also:: HTTPClient, HTTPResponse.getHttpPerformanceData(), getExecutionTime(), getExecutionThroughput()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dumpToStdout()` For debug purpose only, dump the measured data to stdout.
`float`	`getExecutionThroughput()` Get the execution throughput of the HTTP call.
`long`	`getExecutionTime()` Get the execution time of the HTTP call.
`int`	`getNumberOfRetries()` Get the number of retries of the HTTP call.
`long`	`getProcessingTime()` Get the processing time of the HTTP call - inclusive the overhead time at client side to prepare/initialize the HTTP call.
`long`	`getRequestContentSendTime()` Get the elapsed time duration for sending the HTTP request content.
`long`	`getRequestHeaderSendTime()` Get the elapsed time duration for sending the HTTP request header.
`long`	`getRequestSendTime()` Get the elapsed time duration for sending the HTTP request (HTTP request header + HTTP request content, if any).
`long`	`getResponseContentReceiveTime()` Get the elapsed time duration for receiving the HTTP response content.
`long`	`getResponseFirstByteReceiveTime()` Get the elapsed time duration for receiving first byte of the HTTP response after the last byte of the HTTP request was sent.
`long`	`getResponseHeaderReceiveTime()` Get the elapsed time duration after the first byte of the HTTP response header has read until the last byte the HTTP response header has read.
`long`	`getResponseReceiveTime()` Get the elapsed time duration for receiving the HTTP response (HTTP response header + HTTP response content, if any).
`long`	`getSSLHandshakeTime()` Get the time elapsed to perform the SSL/TLS handshake with the server (after the TCP/IP connection was established).
`long`	`getSSLPrepareTime()` Get the time elapsed to prepare (initialize) the SSL/TLS protocol at client side, before the TCP/IP connection is opened to the server.
`long`	`getStartProcessingTimestamp()` Get the timestamp when HTTP call was becoming into the processing state.
`long`	`getStartRetryTimestamp()` Get the timestamp when the latest retry of the HTTP call was started.
`long`	`getTCPConnectTime()` Get the TCP/IP connect time for opening the network connection to the server.
`long`	`getTotalRequestSize()` Get the total sent HTTP request size.
`long`	`getTotalResponseSize()` Get the total received HTTP response size.
`boolean`	`isReusedConnection()` Get if an existing network connection was reused to execute the HTTP call.
`JsonObject`	`toJsonObject()` Get a JSON object of this instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getStartProcessingTimestamp
```
public long getStartProcessingTimestamp()
```
    Get the timestamp when HTTP call was becoming into the processing state.
    
    Returns:
    
    the timestamp when the HTTP call was becoming into the processing state (Unix time)
  - getStartRetryTimestamp
```
public long getStartRetryTimestamp()
```
    Get the timestamp when the latest retry of the HTTP call was started.
    
    Returns:
    
    the timestamp when the latest retry of the HTTP call was started, or -1 if there was no retry of the HTTP call
  - getNumberOfRetries
```
public int getNumberOfRetries()
```
    Get the number of retries of the HTTP call.
    
    Returns:
    
    the number of retries of the HTTP call (0,1, ..)
  - getTotalRequestSize
```
public long getTotalRequestSize()
```
    Get the total sent HTTP request size.
    
    Returns:
    
    the total sent HTTP request size in bytes (HTTP request header + HTTP request content, if any)
  - getTotalResponseSize
```
public long getTotalResponseSize()
```
    Get the total received HTTP response size.
    
    Returns:
    
    the total received HTTP response size in bytes (HTTP response header + HTTP response content, if any)
  - getProcessingTime
```
public long getProcessingTime()
```
    Get the processing time of the HTTP call - inclusive the overhead time at client side to prepare/initialize the HTTP call.
    
    Returns:
    
    the total processing time of the HTTP call in milliseconds.
    
    See Also:
    
    getSSLPrepareTime()
  - getExecutionTime
```
public long getExecutionTime()
```
    Get the execution time of the HTTP call.
    
    Returns:
    
    the execution time of the HTTP call in milliseconds
  - getExecutionThroughput
```
public float getExecutionThroughput()
```
    Get the execution throughput of the HTTP call.
    
    Returns:
    
    the execution throughput of the HTTP call in in megabytes per seconds, or -1.0 if no such data is available
  - isReusedConnection
```
public boolean isReusedConnection()
```
    Get if an existing network connection was reused to execute the HTTP call.
    If an existing network connection was reused then the following performance data are *not* available:
    - SSL prepare time
    - TCP connect time
    - SSL handshake time
    Returns:
    
    true if an existing network connection was reused to execute the HTTP call
  - getSSLPrepareTime
```
public long getSSLPrepareTime()
```
    Get the time elapsed to prepare (initialize) the SSL/TLS protocol at client side, before the TCP/IP connection is opened to the server.
    
    Returns:
    
    the time elapsed to prepare (initialize) the SSL/TLS protocol at client side in milliseconds, or -1 if no encrypted 'https' request was executed, and also -1 if an existing network connection was reused to execute the HTTP call
    
    See Also:
    
    isReusedConnection()
  - getTCPConnectTime
```
public long getTCPConnectTime()
```
    Get the TCP/IP connect time for opening the network connection to the server.
    
    Returns:
    
    the TCP/IP connect time for opening the network connection to the server in milliseconds, or -1 if an existing network connection was reused to execute the HTTP call
    
    See Also:
    
    isReusedConnection()
  - getSSLHandshakeTime
```
public long getSSLHandshakeTime()
```
    Get the time elapsed to perform the SSL/TLS handshake with the server (after the TCP/IP connection was established).
    
    Returns:
    
    the time elapsed to perform the SSL/TLS handshake with the server in milliseconds, or -1 if no encrypted 'https' request was executed, and also -1 if an existing network connection was reused to execute the HTTP call
    
    See Also:
    
    isReusedConnection()
  - getRequestSendTime
```
public long getRequestSendTime()
```
    Get the elapsed time duration for sending the HTTP request (HTTP request header + HTTP request content, if any). Measured from start to send the first byte of the HTTP request until the last byte has sent.
    
    Returns:
    
    the elapsed time duration for sending the HTTP request in milliseconds
  - getRequestHeaderSendTime
```
public long getRequestHeaderSendTime()
```
    Get the elapsed time duration for sending the HTTP request header. Measured from start to send the first byte of the HTTP request header until the last byte has sent.
    
    Returns:
    
    the elapsed time for sending the HTTP request header in milliseconds
  - getRequestContentSendTime
```
public long getRequestContentSendTime()
```
    Get the elapsed time duration for sending the HTTP request content. Measured from start to send the first byte of the HTTP request content until the last byte has sent.
    
    Returns:
    
    the elapsed time for sending the HTTP request content in milliseconds, or -1 if no such data is available
  - getResponseReceiveTime
```
public long getResponseReceiveTime()
```
    Get the elapsed time duration for receiving the HTTP response (HTTP response header + HTTP response content, if any). Measured after the HTTP request has send until the last byte of the HTTP response has received.
    
    Returns:
    
    the elapsed time duration for receiving the HTTP response in milliseconds
  - getResponseFirstByteReceiveTime
```
public long getResponseFirstByteReceiveTime()
```
    Get the elapsed time duration for receiving first byte of the HTTP response after the last byte of the HTTP request was sent.
    
    Returns:
    
    the elapsed time duration in milliseconds for receiving first byte of the HTTP response after the last byte of the HTTP request was sent.
  - getResponseHeaderReceiveTime
```
public long getResponseHeaderReceiveTime()
```
    Get the elapsed time duration after the first byte of the HTTP response header has read until the last byte the HTTP response header has read.
    
    Returns:
    
    the elapsed time duration in milliseconds after the first byte of the HTTP response header has read until the last byte the HTTP response header has read
  - getResponseContentReceiveTime
```
public long getResponseContentReceiveTime()
```
    Get the elapsed time duration for receiving the HTTP response content.
    
    Returns:
    
    the elapsed time for receiving the HTTP response content in milliseconds, or -1 if no such data is available
  - dumpToStdout
```
public void dumpToStdout()
```
    For debug purpose only, dump the measured data to stdout.
  - toJsonObject
```
public JsonObject toJsonObject()
```
    Get a JSON object of this instance.
    
    Returns:
    
    a JSON object of this instance

Class HTTPPerformanceData

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getStartProcessingTimestamp

getStartRetryTimestamp

getNumberOfRetries

getTotalRequestSize

getTotalResponseSize

getProcessingTime

getExecutionTime

getExecutionThroughput

isReusedConnection

getSSLPrepareTime

getTCPConnectTime

getSSLHandshakeTime

getRequestSendTime

getRequestHeaderSendTime

getRequestContentSendTime

getResponseReceiveTime

getResponseFirstByteReceiveTime

getResponseHeaderReceiveTime

getResponseContentReceiveTime

dumpToStdout

toJsonObject