Source

The GSource struct is an opaque data type representing an event source.

Constructors

this
this(GSource* gSource, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this(GSourceFuncs* 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).

Destructor

~this
~this()
Undocumented in source.

Members

Functions

addChildSource
void addChildSource(Source childSource)

Adds @child_source to @source as a "polled" source; when @source is added to a #GMainContext, @child_source will be automatically added with the same priority, when @child_source is triggered, it will cause @source to dispatch (in addition to calling its own callback), and when @source is destroyed, it will destroy @child_source as well. (@source will also still be dispatched if its own prepare/check functions indicate that it is ready.)

addPoll
void addPoll(GPollFD* fd)

Adds a file descriptor to the set of file descriptors polled for this source. This is usually combined with g_source_new() to add an event source. The event source's check function will typically test the @revents field in the #GPollFD struct and return %TRUE if events need to be processed.

addUnixFd
void* addUnixFd(int fd, GIOCondition events)

Monitors @fd for the IO events in @events.

attach
uint attach(MainContext context)

Adds a #GSource to a @context so that it will be executed within that context. Remove it by calling g_source_destroy().

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 removed from their context.

doref
Source doref()

Increases the reference count on a source by one.

getCanRecurse
bool getCanRecurse()

Checks whether a source is allowed to be called recursively. see g_source_set_can_recurse().

getContext
MainContext getContext()

Gets the #GMainContext with which the source is associated.

getCurrentTime
void getCurrentTime(TimeVal timeval)

This function ignores @source and is otherwise the same as g_get_current_time().

getId
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 g_main_context_find_source_by_id().

getName
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 g_source_set_name().

getPriority
int getPriority()

Gets the priority of a source.

getReadyTime
long getReadyTime()

Gets the "ready time" of @source, as set by g_source_set_ready_time().

getSourceStruct
GSource* getSourceStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getTime
long getTime()

Gets the time to be used when checking this source. The advantage of calling this function over calling g_get_monotonic_time() directly is that when checking multiple sources, GLib can cache a single value instead of having to repeatedly get the system monotonic time.

isDestroyed
bool isDestroyed()

Returns whether @source has been destroyed.

modifyUnixFd
void modifyUnixFd(void* tag, GIOCondition newEvents)

Updates the event mask to watch for the fd identified by @tag.

queryUnixFd
GIOCondition queryUnixFd(void* tag)

Queries the events reported for the fd corresponding to @tag on @source during the last poll.

removeChildSource
void removeChildSource(Source childSource)

Detaches @child_source from @source and destroys it.

removePoll
void removePoll(GPollFD* fd)

Removes a file descriptor from the set of file descriptors polled for this source.

removeUnixFd
void removeUnixFd(void* tag)

Reverses the effect of a previous call to g_source_add_unix_fd().

setCallback
void setCallback(GSourceFunc func, void* data, GDestroyNotify notify)

Sets the callback function for a source. The callback for a source is called from the source's dispatch function.

setCallbackIndirect
void setCallbackIndirect(void* callbackData, GSourceCallbackFuncs* callbackFuncs)

Sets the callback function storing the data as a refcounted callback "object". This is used internally. Note that calling g_source_set_callback_indirect() assumes an initial reference count on @callback_data, and thus @callback_funcs->unref will eventually be called once more than @callback_funcs->ref.

setCanRecurse
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 source is blocked until the dispatch function returns.

setFuncs
void setFuncs(GSourceFuncs* funcs)

Sets the source functions (can be used to override default implementations) of an unattached source.

setName
void setName(string name)

Sets a name for the source, used in debugging and profiling. The name defaults to #NULL.

setPriority
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 be dispatched.

setReadyTime
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 dispatched immediately.

unref
void unref()

Decreases the reference count of a source by one. If the resulting reference count is zero the source and associated memory will be destroyed.

Static functions

remove
bool remove(uint tag)

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

removeByFuncsUserData
bool removeByFuncsUserData(GSourceFuncs* funcs, void* userData)

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.

removeByUserData
bool removeByUserData(void* userData)

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.

setNameById
void setNameById(uint tag, string name)

Sets the name of a source using its ID.

Variables

gSource
GSource* gSource;

the main Gtk struct

ownedRef
bool ownedRef;
Undocumented in source.

Meta