Gjsify LogoGjsify Logo

SoupMessageMetrics contains metrics collected while loading a #SoupMessage either from the network or the disk cache.

Temporal metrics are expressed as a monotonic time and always start with a fetch start event and finish with response end. All other events are optional. An event can be 0 because it hasn't happened yet, because it's optional or because the load failed before the event reached.

Size metrics are expressed in bytes and aree updated while the #SoupMessage is being loaded. You can connect to different #SoupMessage signals to get the final result of every value.

record

Hierarchy

  • MessageMetrics

Index

Constructors

Properties

name: string

Methods

  • free(): void
  • getConnectEnd(): number
  • Get the time immediately after the #SoupMessage completed the connection to the server. This includes the time for the proxy negotiation and TLS handshake. It will be 0 if no network connection was required to fetch the resource (a persistent connection was used or resource was loaded from the local disk cache).

    Returns number

  • getConnectStart(): number
  • Get the time immediately before the #SoupMessage started to establish the connection to the server. It will be 0 if no network connection was required to fetch the resource (a persistent connection was used or resource was loaded from the local disk cache).

    Returns number

  • getDnsEnd(): number
  • Get the time immediately after the #SoupMessage completed the domain lookup name for the resource. It will be 0 if no domain lookup was required to fetch the resource (a persistent connection was used or resource was loaded from the local disk cache).

    Returns number

  • getDnsStart(): number
  • Get the time immediately before the #SoupMessage started the domain lookup name for the resource. It will be 0 if no domain lookup was required to fetch the resource (a persistent connection was used or resource was loaded from the local disk cache).

    Returns number

  • getFetchStart(): number
  • Get the time immediately before the #SoupMessage started to fetch a resource either from a remote server or local disk cache.

    Returns number

  • getRequestBodyBytesSent(): number
  • Get the number of bytes sent to the network for the request body. This is the size of the body sent, after encodings are applied, so it might be greater than the value returned by soup_message_metrics_get_request_body_size(). This value is available right before #SoupMessage::wrote-body signal is emitted, but you might get an intermediate value if called before.

    Returns number

  • getRequestBodySize(): number
  • Get the request body size in bytes. This is the size of the original body given to the request before any encoding is applied. This value is available right before #SoupMessage::wrote-body signal is emitted, but you might get an intermediate value if called before.

    Returns number

  • getRequestHeaderBytesSent(): number
  • Get the number of bytes sent to the network for the request headers. This value is available right before #SoupMessage::wrote-headers signal is emitted, but you might get an intermediate value if called before.

    Returns number

  • getRequestStart(): number
  • Get the time immediately before the #SoupMessage started the request of the resource from the server or the local disk cache.

    Returns number

  • getResponseBodyBytesReceived(): number
  • Get the number of bytes received from the network for the response body. This value is available right before #SoupMessage::got-body signal is emitted, but you might get an intermediate value if called before. For resources loaded from the disk cache this value is always 0.

    Returns number

  • getResponseBodySize(): number
  • Get the response body size in bytes. This is the size of the body as given to the user after all encodings are applied, so it might be greater than the value returned by soup_message_metrics_get_response_body_bytes_received(). This value is available right before #SoupMessage::got-body signal is emitted, but you might get an intermediate value if called before.

    Returns number

  • getResponseEnd(): number
  • Get the time immediately after the #SoupMessage received the last bytes of the response from the server or the local disk cache. In case of load failure, this returns the time immediately before the fetch is aborted.

    Returns number

  • getResponseHeaderBytesReceived(): number
  • Get the number of bytes received from the network for the response headers. This value is available right before #SoupMessage::got-headers signal is emitted, but you might get an intermediate value if called before. For resources loaded from the disk cache this value is always 0.

    Returns number

  • getResponseStart(): number
  • Get the time immediately after the #SoupMessage received the first bytes of the response from the server or the local disk cache.

    Returns number

  • getTlsStart(): number
  • Get the time immediately before the #SoupMessage started the TLS handshake. It will be 0 if no TLS handshake was required to fetch the resource (connection was not secure, a persistent connection was used or resource was loaded from the local disk cache).

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method