Class MessageMetrics

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.soup.MessageMetrics
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class MessageMetrics extends ProxyInstance

Contains metrics collected while loading a Message either from the network or the disk cache.

Metrics are not collected by default for a Message, you need to add the flag MessageFlags.COLLECT_METRICS to enable the feature.

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 are updated while the Message is being loaded. You can connect to different Message signals to get the final result of every value.

  • Constructor Details

    • MessageMetrics

      public MessageMetrics(MemorySegment address)
      Create a MessageMetrics proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the MessageMetrics class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • copy

      public MessageMetrics copy()
      Copies metrics.
      Returns:
      a copy of this MessageMetrics

    • free

      public void free()
      Frees metrics.

    • getConnectEnd

      public long getConnectEnd()

      Get the time immediately after the Message 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:
      the connection end time

    • getConnectStart

      public long getConnectStart()

      Get the time immediately before the Message 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:
      the connection start time

    • getDnsEnd

      public long getDnsEnd()

      Get the time immediately after the Message 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:
      the domain lookup end time

    • getDnsStart

      public long getDnsStart()

      Get the time immediately before the Message 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:
      the domain lookup start time

    • getFetchStart

      public long getFetchStart()
      Get the time immediately before the Message started to fetch a resource either from a remote server or local disk cache.
      Returns:
      the fetch start time

    • getRequestBodyBytesSent

      public long getRequestBodyBytesSent()

      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 getRequestBodySize(). This value is available right before Message::wrote-body signal is emitted, but you might get an intermediate value if called before.

      Returns:
      the request body bytes sent

    • getRequestBodySize

      public long getRequestBodySize()

      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 Message::wrote-body signal is emitted, but you might get an intermediate value if called before.

      Returns:
      the request body size

    • getRequestHeaderBytesSent

      public long getRequestHeaderBytesSent()

      Get the number of bytes sent to the network for the request headers.

      This value is available right before Message::wrote-headers signal is emitted, but you might get an intermediate value if called before.

      Returns:
      the request headers bytes sent

    • getRequestStart

      public long getRequestStart()
      Get the time immediately before the Message started the request of the resource from the server or the local disk cache.
      Returns:
      the request start time

    • getResponseBodyBytesReceived

      public long getResponseBodyBytesReceived()

      Get the number of bytes received from the network for the response body.

      This value is available right before Message::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:
      the response body bytes received

    • getResponseBodySize

      public long getResponseBodySize()

      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 getResponseBodyBytesReceived(). This value is available right before Message::got-body signal is emitted, but you might get an intermediate value if called before.

      Returns:
      the response body size

    • getResponseEnd

      public long getResponseEnd()

      Get the time immediately after the Message 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:
      the response end time

    • getResponseHeaderBytesReceived

      public long getResponseHeaderBytesReceived()

      Get the number of bytes received from the network for the response headers.

      This value is available right before Message::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:
      the response headers bytes received

    • getResponseStart

      public long getResponseStart()
      Get the time immediately after the Message received the first bytes of the response from the server or the local disk cache.
      Returns:
      the response start time

    • getTlsStart

      public long getTlsStart()

      Get the time immediately before the Message 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:
      the tls start time