Package ch.bailu.gtk.glib

Klasse SourceFuncs

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.type.Record

ch.bailu.gtk.glib.SourceFuncs

Alle implementierten Schnittstellen:

PointerInterface

public class SourceFuncs
extends Record

The `GSourceFuncs` struct contains a table of
functions used to handle event sources in a generic manner.

For idle sources, the prepare and check functions always return %TRUE
to indicate that the source is always ready to be processed. The prepare
function also returns a timeout value of 0 to ensure that the poll() call
doesn't block (since that would be time wasted which could have been spent
running the idle function).

For timeout sources, the prepare and check functions both return %TRUE
if the timeout interval has expired. The prepare function also returns
a timeout value to ensure that the poll() call doesn't block too long
and miss the next timeout.

For file descriptor sources, the prepare function typically returns %FALSE,
since it must wait until poll() has been called before it knows whether
any events need to be processed. It sets the returned timeout to -1 to
indicate that it doesn't mind how long the poll() call blocks. In the
check function, it tests the results of the poll() call to see if the
required condition has been met, and returns %TRUE if so.

https://docs.gtk.org/glib/struct.SourceFuncs.html

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static interface	SourceFuncs.OnSourceDummyMarshal
static interface	SourceFuncs.OnSourceFunc
static interface	SourceFuncs.OnSourceFuncsCheckFunc
static interface	SourceFuncs.OnSourceFuncsFinalizeFunc
static interface	SourceFuncs.OnSourceFuncsPrepareFunc

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	CHECK	Called after all the file descriptors are polled.
static final String	CLOSURE_CALLBACK	See SourceFuncs.OnSourceFunc.onSourceFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.type.Pointer)
static final String	CLOSURE_MARSHAL	See SourceFuncs.OnSourceDummyMarshal.onSourceDummyMarshal(ch.bailu.gtk.lib.handler.CallbackHandler)
static final String	DISPATCH	Called to dispatch the event source, after it has returned %TRUE in either its @prepare or its @check function, or if a ready time has been reached.
static final String	FINALIZE	Called when the source is finalized.
static final String	PREPARE	Called before all the file descriptors are polled.

Von Klasse geerbte Felder ch.bailu.gtk.type.Pointer

NULL

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
SourceFuncs()
SourceFuncs(PointerContainer pointer)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static ClassHandler	getClassHandler()
ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceFuncsCheckFunc	getFieldCheck()	Called after all the file descriptors are polled.
ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceFunc	getFieldClosureCallback()	See SourceFuncs.OnSourceFunc.onSourceFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.type.Pointer)
ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceDummyMarshal	getFieldClosureMarshal()	See SourceFuncs.OnSourceDummyMarshal.onSourceDummyMarshal(ch.bailu.gtk.lib.handler.CallbackHandler)
ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceFuncsFinalizeFunc	getFieldFinalize()	Called when the source is finalized.
ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceFuncsPrepareFunc	getFieldPrepare()	Called before all the file descriptors are polled.
void	setFieldCheck(SourceFuncs.OnSourceFuncsCheckFunc check)	Called after all the file descriptors are polled.
void	setFieldClosureCallback(SourceFuncs.OnSourceFunc closure_callback)	See SourceFuncs.OnSourceFunc.onSourceFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.type.Pointer)
void	setFieldClosureMarshal(SourceFuncs.OnSourceDummyMarshal closure_marshal)	See SourceFuncs.OnSourceDummyMarshal.onSourceDummyMarshal(ch.bailu.gtk.lib.handler.CallbackHandler)
void	setFieldFinalize(SourceFuncs.OnSourceFuncsFinalizeFunc finalize)	Called when the source is finalized.
void	setFieldPrepare(SourceFuncs.OnSourceFuncsPrepareFunc prepare)	Called before all the file descriptors are polled.

Von Klasse geerbte Methoden ch.bailu.gtk.type.Record

destroy

Von Klasse geerbte Methoden ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Von Klasse geerbte Methoden ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Von Klasse geerbte Methoden java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Felddetails

PREPARE

public static final String PREPARE

Called before all the file descriptors are polled. If the
source can determine that it is ready here (without waiting for the
results of the poll() call) it should return %TRUE. It can also return
a @timeout_ value which should be the maximum timeout (in milliseconds)
which should be passed to the poll() call. The actual timeout used will
be -1 if all sources returned -1, or it will be the minimum of all
the @timeout_ values returned which were >= 0. Since 2.36 this may
be %NULL, in which case the effect is as if the function always returns
%FALSE with a timeout of -1. If @prepare returns a
timeout and the source also has a ready time set, then the
lower of the two will be used.
See SourceFuncs.OnSourceFuncsPrepareFunc.onSourceFuncsPrepareFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source, ch.bailu.gtk.type.Int)

Siehe auch:

• Konstantenfeldwerte

CHECK

public static final String CHECK

Called after all the file descriptors are polled. The source
should return %TRUE if it is ready to be dispatched. Note that some
time may have passed since the previous prepare function was called,
so the source should be checked again here. Since 2.36 this may
be %NULL, in which case the effect is as if the function always returns
%FALSE.
See SourceFuncs.OnSourceFuncsCheckFunc.onSourceFuncsCheckFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source)

Siehe auch:

• Konstantenfeldwerte

DISPATCH

public static final String DISPATCH

Called to dispatch the event source, after it has returned
%TRUE in either its @prepare or its @check function, or if a ready time
has been reached. The @dispatch function receives a callback function and
user data. The callback function may be %NULL if the source was never
connected to a callback using [method@GLib.Source.set_callback]. The
@dispatch function should call the callback function with @user_data and
whatever additional parameters are needed for this type of event source.
The return value of the @dispatch function should be
[const@GLib.SOURCE_REMOVE] if the source should be removed or
[const@GLib.SOURCE_CONTINUE] to keep it.
Private field: cb-with-cb

Siehe auch:

• Konstantenfeldwerte

FINALIZE

public static final String FINALIZE

Called when the source is finalized. At this point, the source
will have been destroyed, had its callback cleared, and have been removed
from its [struct@GLib.MainContext], but it will still have its final
reference count, so methods can be called on it from within this
function.
See SourceFuncs.OnSourceFuncsFinalizeFunc.onSourceFuncsFinalizeFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source)

Siehe auch:

• Konstantenfeldwerte

CLOSURE_CALLBACK

public static final String CLOSURE_CALLBACK

See SourceFuncs.OnSourceFunc.onSourceFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.type.Pointer)

Siehe auch:

• Konstantenfeldwerte

CLOSURE_MARSHAL

public static final String CLOSURE_MARSHAL

See SourceFuncs.OnSourceDummyMarshal.onSourceDummyMarshal(ch.bailu.gtk.lib.handler.CallbackHandler)

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

SourceFuncs

public SourceFuncs(PointerContainer pointer)

SourceFuncs

public SourceFuncs()

Methodendetails

getClassHandler

public static ClassHandler getClassHandler()

setFieldPrepare

public void setFieldPrepare(SourceFuncs.OnSourceFuncsPrepareFunc prepare)

Called before all the file descriptors are polled. If the
source can determine that it is ready here (without waiting for the
results of the poll() call) it should return %TRUE. It can also return
a @timeout_ value which should be the maximum timeout (in milliseconds)
which should be passed to the poll() call. The actual timeout used will
be -1 if all sources returned -1, or it will be the minimum of all
the @timeout_ values returned which were >= 0. Since 2.36 this may
be %NULL, in which case the effect is as if the function always returns
%FALSE with a timeout of -1. If @prepare returns a
timeout and the source also has a ready time set, then the
lower of the two will be used.
See SourceFuncs.OnSourceFuncsPrepareFunc.onSourceFuncsPrepareFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source, ch.bailu.gtk.type.Int)

getFieldPrepare

public ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceFuncsPrepareFunc getFieldPrepare()

Called before all the file descriptors are polled. If the
source can determine that it is ready here (without waiting for the
results of the poll() call) it should return %TRUE. It can also return
a @timeout_ value which should be the maximum timeout (in milliseconds)
which should be passed to the poll() call. The actual timeout used will
be -1 if all sources returned -1, or it will be the minimum of all
the @timeout_ values returned which were >= 0. Since 2.36 this may
be %NULL, in which case the effect is as if the function always returns
%FALSE with a timeout of -1. If @prepare returns a
timeout and the source also has a ready time set, then the
lower of the two will be used.
See SourceFuncs.OnSourceFuncsPrepareFunc.onSourceFuncsPrepareFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source, ch.bailu.gtk.type.Int)

setFieldCheck

public void setFieldCheck(SourceFuncs.OnSourceFuncsCheckFunc check)

Called after all the file descriptors are polled. The source
should return %TRUE if it is ready to be dispatched. Note that some
time may have passed since the previous prepare function was called,
so the source should be checked again here. Since 2.36 this may
be %NULL, in which case the effect is as if the function always returns
%FALSE.
See SourceFuncs.OnSourceFuncsCheckFunc.onSourceFuncsCheckFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source)

getFieldCheck

public ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceFuncsCheckFunc getFieldCheck()

Called after all the file descriptors are polled. The source
should return %TRUE if it is ready to be dispatched. Note that some
time may have passed since the previous prepare function was called,
so the source should be checked again here. Since 2.36 this may
be %NULL, in which case the effect is as if the function always returns
%FALSE.
See SourceFuncs.OnSourceFuncsCheckFunc.onSourceFuncsCheckFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source)

setFieldFinalize

public void setFieldFinalize(SourceFuncs.OnSourceFuncsFinalizeFunc finalize)

Called when the source is finalized. At this point, the source
will have been destroyed, had its callback cleared, and have been removed
from its [struct@GLib.MainContext], but it will still have its final
reference count, so methods can be called on it from within this
function.
See SourceFuncs.OnSourceFuncsFinalizeFunc.onSourceFuncsFinalizeFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source)

getFieldFinalize

public ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceFuncsFinalizeFunc getFieldFinalize()

Called when the source is finalized. At this point, the source
will have been destroyed, had its callback cleared, and have been removed
from its [struct@GLib.MainContext], but it will still have its final
reference count, so methods can be called on it from within this
function.
See SourceFuncs.OnSourceFuncsFinalizeFunc.onSourceFuncsFinalizeFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.glib.Source)

setFieldClosureCallback

public void setFieldClosureCallback(SourceFuncs.OnSourceFunc closure_callback)

See SourceFuncs.OnSourceFunc.onSourceFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.type.Pointer)

getFieldClosureCallback

public ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceFunc getFieldClosureCallback()

See SourceFuncs.OnSourceFunc.onSourceFunc(ch.bailu.gtk.lib.handler.CallbackHandler, ch.bailu.gtk.type.Pointer)

setFieldClosureMarshal

public void setFieldClosureMarshal(SourceFuncs.OnSourceDummyMarshal closure_marshal)

See SourceFuncs.OnSourceDummyMarshal.onSourceDummyMarshal(ch.bailu.gtk.lib.handler.CallbackHandler)

getFieldClosureMarshal

public ch.bailu.gtk.glib.JnaSourceFuncs.OnSourceDummyMarshal getFieldClosureMarshal()

See SourceFuncs.OnSourceDummyMarshal.onSourceDummyMarshal(ch.bailu.gtk.lib.handler.CallbackHandler)