Function

GLib-2.0GLibtimeout_add_secondsSince 2.14

  • Sets a function to be called at regular intervals, with priority.

    The function is called repeatedly until it returns GLib.SOURCE_REMOVE, at which point the timeout is automatically destroyed and the function will not be called again.

    Unlike GLib.timeout_add, this function operates at whole second granularity. The initial starting point of the timer is determined by the implementation and the implementation is expected to group multiple timers together so that they fire all at the same time. To allow this grouping, the interval to the first timer is rounded and can deviate up to one second from the specified interval. Subsequent timer iterations will generally run at the specified interval.

    Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval

    See main loop memory management for details on how to handle the return value and memory management of data.

    If you want timing more precise than whole seconds, use GLib.timeout_add instead.

    The grouping of timers to fire at the same time results in a more power and CPU efficient behavior so if your timer is in multiples of seconds and you don’t require the first timer exactly one second from now, the use of GLib.timeout_add_seconds is preferred over GLib.timeout_add.

    This internally creates a main loop source using GLib.timeout_source_new_seconds and attaches it to the main loop context using GLib.Source.attach. You can do these steps manually if you need greater control.

    It is safe to call this function from any thread.

    The interval given is in terms of monotonic time, not wall clock time. See GLib.get_monotonic_time.

    Parameters

    • priority: number

      the priority of the timeout source; typically this will be in the range between GLib.PRIORITY_DEFAULT and GLib.PRIORITY_HIGH

    • interval: number

      the time between calls to the function, in seconds

    • _function: SourceFunc

      function to call

    • Optionalnotify: DestroyNotify

      function to call when the timeout is removed

    Returns number

    the ID (greater than 0) of the event source

    2.14