Class (GI Struct)

GLib-2.0 ▶ GLib ▶ TimeValDeprecated 2.62

Represents a precise time, with seconds and microseconds.

Similar to the struct timeval returned by the gettimeofday() UNIX system call.

GLib is attempting to unify around the use of 64-bit integers to represent microsecond-precision time. As such, this type will be removed from a future version of GLib. A consequence of using glong for tv_sec is that on 32-bit systems GLib.TimeVal is subject to the year 2038 problem.

since 2.62: Use GLib.DateTime or guint64 instead.

Index

Constructors

constructor

Properties

tv_sec tv_usec $gtype

Methods

add to_iso8601 from_iso8601

Constructors

  • Parameters

    • OptionalDeprecatedproperties: Partial<{ tv_sec: number; tv_usec: number }>

    Returns TimeVal

Properties

tv_sec: number
tv_usec: number
$gtype: GType<TimeVal>

Methods

  • Adds the given number of microseconds to time_. microseconds can also be negative to decrease the value of time_.

    Parameters

    • Deprecatedmicroseconds: number

      number of microseconds to add to time

    Returns void

  • Converts time_ into an RFC 3339 encoded string, relative to the Coordinated Universal Time (UTC). This is one of the many formats allowed by ISO 8601.

    ISO 8601 allows a large number of date/time formats, with or without punctuation and optional elements. The format returned by this function is a complete date and time, with optional punctuation included, the UTC time zone represented as "Z", and the tv_usec part included if and only if it is nonzero, i.e. either "YYYY-MM-DDTHH:MM:SSZ" or "YYYY-MM-DDTHH:MM:SS.fffffZ".

    This corresponds to the Internet date/time format defined by RFC 3339, and to either of the two most-precise formats defined by the W3C Note Date and Time Formats. Both of these documents are profiles of ISO 8601.

    Use g_date_time_format() or g_strdup_printf() if a different variation of ISO 8601 format is required.

    If time_ represents a date which is too large to fit into a struct tm, null will be returned. This is platform dependent. Note also that since GLib.TimeVal stores the number of seconds as a glong, on 32-bit systems it is subject to the year 2038 problem. Accordingly, since GLib 2.62, this function has been deprecated. Equivalent functionality is available using:

    GDateTime *dt = g_date_time_new_from_unix_utc (time_val);
    iso8601_string = g_date_time_format_iso8601 (dt);
    g_date_time_unref (dt);

    The return value of g_time_val_to_iso8601() has been nullable since GLib 2.54; before then, GLib would crash under the same conditions.

    Returns string

    a newly allocated string containing an ISO 8601 date, or null if time_ was too large

  • Converts a string containing an ISO 8601 encoded date and time to a GLib.TimeVal and puts it into time_.

    iso_date must include year, month, day, hours, minutes, and seconds. It can optionally include fractions of a second and a time zone indicator. (In the absence of any time zone indication, the timestamp is assumed to be in local time.)

    Any leading or trailing space in iso_date is ignored.

    This function was deprecated, along with GLib.TimeVal itself, in GLib 2.62. Equivalent functionality is available using code like:

    GDateTime *dt = g_date_time_new_from_iso8601 (iso8601_string, NULL);
    gint64 time_val = g_date_time_to_unix (dt);
    g_date_time_unref (dt);

    Parameters

    • Deprecatediso_date: string

      an ISO 8601 encoded date string

    Returns [boolean, TimeVal]