glib.source
Module for [Source] class
class Source
Types 1
classSource : gobject.boxed.Boxed
The [glib.source.Source] struct is an opaque data type representing an event source.
Methods
void addChildSource(glib.source.Source childSource)Adds childsource to source as a "polled" source; when source is added to a #GMainContext, childsource will be automatically added with the same priority, when childsource is triggered, it will caus...void addPoll(glib.types.PollFD fd)Adds a file descriptor to the set of file descriptors polled for this source. This is usually combined with [glib.source.Source.new_] to add an event source. The event source's check function will ...void * addUnixFd(int fd, glib.types.IOCondition events)Monitors fd for the IO events in events.uint attach(glib.main_context.MainContext context = null)Adds a #GSource to a context so that it will be executed within that context. Remove it by calling [glib.source.Source.destroy].void destroy()Removes a source from its #GMainContext, if any, and mark it as destroyed. The source cannot be subsequently added to another context. It is safe to call this on sources which have already been re...bool getCanRecurse()Checks whether a source is allowed to be called recursively. see [glib.source.Source.setCanRecurse]. Returns: whether recursion is allowed.glib.main_context.MainContext getContext()Gets the #GMainContext with which the source is associated.void getCurrentTime(glib.time_val.TimeVal timeval)This function ignores source and is otherwise the same as [glib.global.getCurrentTime].uint getId()Returns the numeric ID for a particular source. The ID of a source is a positive integer which is unique within a particular main loop context. The reverse mapping from ID to source is done by [gli...string getName()Gets a name for the source, used in debugging and profiling. The name may be #NULL if it has never been set with [glib.source.Source.setName]. Returns: the name of the sourceint getPriority()Gets the priority of a source. Returns: the priority of the sourcelong getReadyTime()Gets the "ready time" of source, as set by [glib.source.Source.setReadyTime].long getTime()Gets the time to be used when checking this source. The advantage of calling this function over calling [glib.global.getMonotonicTime] directly is that when checking multiple sources, GLib can cach...bool isDestroyed()Returns whether source has been destroyed.void modifyUnixFd(void * tag, glib.types.IOCondition newEvents)Updates the event mask to watch for the fd identified by tag.glib.types.IOCondition queryUnixFd(void * tag)Queries the events reported for the fd corresponding to tag on source during the last poll.void removeChildSource(glib.source.Source childSource)Detaches child_source from source and destroys it.void removePoll(glib.types.PollFD fd)Removes a file descriptor from the set of file descriptors polled for this source.void removeUnixFd(void * tag)Reverses the effect of a previous call to [glib.source.Source.addUnixFd].void setCallback(glib.types.SourceFunc func)Sets the callback function for a source. The callback for a source is called from the source's dispatch function.void setCallbackIndirect(void * callbackData, glib.types.SourceCallbackFuncs callbackFuncs)Sets the callback function storing the data as a refcounted callback "object". This is used internally. Note that calling [glib.source.Source.setCallbackIndirect] assumes an initial reference count...void setCanRecurse(bool canRecurse)Sets whether a source can be called recursively. If can_recurse is true, then while the source is being dispatched then this source will be processed normally. Otherwise, all processing of this sou...void setFuncs(glib.types.SourceFuncs funcs)Sets the source functions (can be used to override default implementations) of an unattached source.void setName(string name)Sets a name for the source, used in debugging and profiling. The name defaults to #NULL.void setPriority(int priority)Sets the priority of a source. While the main loop is being run, a source will be dispatched if it is ready to be dispatched and no sources at a higher (numerically smaller) priority are ready to b...void setReadyTime(long readyTime)Sets a #GSource to be dispatched when the given monotonic time is reached (or passed). If the monotonic time is in the past (as it always will be if ready_time is 0) then the source will be dispat...void setStaticName(string name)A variant of [glib.source.Source.setName] that does not duplicate the name, and can only be used with string literals.bool remove(uint tag)Removes the source with the given ID from the default main context. You must use [glib.source.Source.destroy] for sources added to a non-default main context.bool removeByFuncsUserData(glib.types.SourceFuncs funcs, void * userData = null)Removes a source from the default main loop context given the source functions and user data. If multiple sources exist with the same source functions and user data, only one will be destroyed.bool removeByUserData(void * userData = null)Removes a source from the default main loop context given the user data for the callback. If multiple sources exist with the same user data, only one will be destroyed.void setNameById(uint tag, string name)Sets the name of a source using its ID.Constructors
this(glib.types.SourceFuncs sourceFuncs, uint structSize)Creates a new #GSource structure. The size is specified to allow creating structures derived from #GSource that contain additional data. The size passed in must be at least `sizeof (GSource)`.