Source.remove

Removes the source with the given ID from the default main context. You must use Source.destroy for sources added to a non-default main context.

The ID of a glib.Source is given by Source.getId, or will be returned by the functions Source.attach, Idle.add, Idle.addFull, Timeout.add, Timeout.addFull, g_child_watch_add(), g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().

It is a programmer error to attempt to remove a non-existent source.

More specifically: source IDs can be reissued after a source has been destroyed and therefore it is never valid to use this function with a source ID which may have already been removed. An example is when scheduling an idle to run in another thread with Idle.add: the idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source.

class Source
static
bool
remove
(
uint tag
)

Parameters

tag uint

the ID of the source to remove.

Return Value

Type: bool

For historical reasons, this function always returns TRUE