MainContext

The glib.main_context.MainContext struct is an opaque data type representing a set of sources to be handled in a main loop.

Constructors

this
this()

Creates a new #GMainContext structure.

Members

Functions

acquire
bool acquire()

Tries to become the owner of the specified context. If some other thread is the owner of the context, returns false immediately. Ownership is properly recursive: the owner can require ownership again and will release ownership when glib.main_context.MainContext.release is called as many times as glib.main_context.MainContext.acquire.

addPoll
void addPoll(glib.types.PollFD fd, int priority)

Adds a file descriptor to the set of file descriptors polled for this context. This will very seldom be used directly. Instead a typical event source will use glib.source.Source.addUnixFd instead.

check
bool check(int maxPriority, glib.types.PollFD[] fds)

Passes the results of polling back to the main loop. You should be careful to pass fds and its length n_fds as received from glib.main_context.MainContext.query, as this functions relies on assumptions on how fds is filled.

dispatch
void dispatch()

Dispatches all pending sources.

findSourceByFuncsUserData
glib.source.Source findSourceByFuncsUserData(glib.types.SourceFuncs funcs, void* userData)

Finds a source with the given source functions and user data. If multiple sources exist with the same source function and user data, the first one found will be returned.

findSourceById
glib.source.Source findSourceById(uint sourceId)

Finds a #GSource given a pair of context and ID.

findSourceByUserData
glib.source.Source findSourceByUserData(void* userData)

Finds a source with the given user data for the callback. If multiple sources exist with the same user data, the first one found will be returned.

invokeFull
void invokeFull(int priority, glib.types.SourceFunc function_)

Invokes a function in such a way that context is owned during the invocation of function.

isOwner
bool isOwner()

Determines whether this thread holds the (recursive) ownership of this #GMainContext. This is useful to know before waiting on another thread that may be blocking to get ownership of context.

iteration
bool iteration(bool mayBlock)

Runs a single iteration for the given main loop. This involves checking to see if any event sources are ready to be processed, then if no events sources are ready and may_block is true, waiting for a source to become ready, then dispatching the highest priority events sources that are ready. Otherwise, if may_block is false sources are not waited to become ready, only those highest priority events sources will be dispatched (if any), that are ready at this given moment without further waiting.

pending
bool pending()

Checks if any sources have pending events for the given context.

popThreadDefault
void popThreadDefault()

Pops context off the thread-default context stack (verifying that it was on the top of the stack).

prepare
bool prepare(int priority)

Prepares to poll sources within a main loop. The resulting information for polling is determined by calling g_main_context_query ().

pushThreadDefault
void pushThreadDefault()

Acquires context and sets it as the thread-default context for the current thread. This will cause certain asynchronous operations (such as most giogio-based I/O) which are started in this thread to run under context and deliver their results to its main loop, rather than running under the global default main context in the main thread. Note that calling this function changes the context returned by glib.main_context.MainContext.getThreadDefault, not the one returned by glib.main_context.MainContext.default_, so it does not affect the context used by functions like glib.global.idleAdd.

query
int query(int maxPriority, int timeout, glib.types.PollFD[] fds)

Determines information necessary to poll this main loop. You should be careful to pass the resulting fds array and its length n_fds as is when calling glib.main_context.MainContext.check, as this function relies on assumptions made when the array is filled.

release
void release()

Releases ownership of a context previously acquired by this thread with glib.main_context.MainContext.acquire. If the context was acquired multiple times, the ownership will be released only when glib.main_context.MainContext.release is called as many times as it was acquired.

removePoll
void removePoll(glib.types.PollFD fd)

Removes file descriptor from the set of file descriptors to be polled for a particular context.

wait
bool wait(glib.cond.Cond cond, glib.mutex.Mutex mutex)

Tries to become the owner of the specified context, as with glib.main_context.MainContext.acquire. But if another thread is the owner, atomically drop mutex and wait on cond until that owner releases ownership or until cond is signaled, then try again (once) to become the owner.

wakeup
void wakeup()

If context is currently blocking in glib.main_context.MainContext.iteration waiting for a source to become ready, cause it to stop blocking and return. Otherwise, cause the next invocation of glib.main_context.MainContext.iteration to return without blocking.

Static functions

default_
glib.main_context.MainContext default_()

Returns the global-default main context. This is the main context used for main loop functions when a main loop is not explicitly specified, and corresponds to the "main" main loop. See also glib.main_context.MainContext.getThreadDefault.

getThreadDefault
glib.main_context.MainContext getThreadDefault()

Gets the thread-default #GMainContext for this thread. Asynchronous operations that want to be able to be run in contexts other than the default one should call this method or glib.main_context.MainContext.refThreadDefault to get a #GMainContext to add their #GSources to. (Note that even in single-threaded programs applications may sometimes want to temporarily push a non-default context, so it is not safe to assume that this will always return null if you are running in the default thread.)

newWithFlags
glib.main_context.MainContext newWithFlags(glib.types.MainContextFlags flags)

Creates a new #GMainContext structure.

refThreadDefault
glib.main_context.MainContext refThreadDefault()

Gets the thread-default #GMainContext for this thread, as with glib.main_context.MainContext.getThreadDefault, but also adds a reference to it with glib.main_context.MainContext.ref_. In addition, unlike glib.main_context.MainContext.getThreadDefault, if the thread-default context is the global-default context, this will return that #GMainContext (with a ref added to it) rather than returning null.

Inherited Members

From Boxed

cInstancePtr
void* cInstancePtr;

Pointer to the C boxed value

getType
GType getType()

Get the GType of this boxed type.

gType
GType gType [@property getter]

Boxed GType property.

self
Boxed self()

Convenience method to return this cast to a type. For use in D with statements.

copy_
void* copy_()

Make a copy of the wrapped C boxed data.

boxedCopy
void* boxedCopy(void* cBoxed)

Copy a C boxed value using g_boxed_copy.

boxedFree
void boxedFree(void* cBoxed)

Free a C boxed value using g_boxed_free.