Package org.gnome.glib

Class SourceFuncs

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.glib.SourceFuncs

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class SourceFuncs
extends ProxyInstance

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.

Constructor Summary

Constructors

Constructor	Description
SourceFuncs()	Allocate a new SourceFuncs.
SourceFuncs(Arena arena)	Allocate a new SourceFuncs.
SourceFuncs(MemorySegment address)	Create a SourceFuncs proxy instance for the provided memory address.
SourceFuncs(SourceFuncsPrepareFunc prepare, SourceFuncsCheckFunc check, SourceFuncsDispatchFunc dispatch, SourceFuncsFinalizeFunc finalize_, SourceFunc closureCallback, SourceDummyMarshal closureMarshal)	Allocate a new SourceFuncs with the fields set to the provided values.
SourceFuncs(SourceFuncsPrepareFunc prepare, SourceFuncsCheckFunc check, SourceFuncsDispatchFunc dispatch, SourceFuncsFinalizeFunc finalize_, SourceFunc closureCallback, SourceDummyMarshal closureMarshal, Arena arena)	Allocate a new SourceFuncs with the fields set to the provided values.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
SourceFuncsCheckFunc	readCheck()	Read the value of the field check.
SourceFunc	readClosureCallback()	Read the value of the field closure_callback.
SourceDummyMarshal	readClosureMarshal()	Read the value of the field closure_marshal.
SourceFuncsDispatchFunc	readDispatch()	Read the value of the field dispatch.
SourceFuncsFinalizeFunc	readFinalize()	Read the value of the field finalize.
SourceFuncsPrepareFunc	readPrepare()	Read the value of the field prepare.
void	writeCheck(SourceFuncsCheckFunc check, Arena _arena)	Write a value in the field check.
void	writeClosureCallback(SourceFunc closureCallback, Arena _arena)	Write a value in the field closure_callback.
void	writeClosureMarshal(SourceDummyMarshal closureMarshal, Arena _arena)	Write a value in the field closure_marshal.
void	writeDispatch(SourceFuncsDispatchFunc dispatch, Arena _arena)	Write a value in the field dispatch.
void	writeFinalize(SourceFuncsFinalizeFunc finalize_, Arena _arena)	Write a value in the field finalize.
void	writePrepare(SourceFuncsPrepareFunc prepare, Arena _arena)	Write a value in the field prepare.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

SourceFuncs

public SourceFuncs(MemorySegment address)

Create a SourceFuncs proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SourceFuncs

public SourceFuncs(Arena arena)

Allocate a new SourceFuncs.

Parameters:

arena - to control the memory allocation scope

SourceFuncs

public SourceFuncs()

Allocate a new SourceFuncs. The memory is allocated with Arena.ofAuto().

SourceFuncs

public SourceFuncs(SourceFuncsPrepareFunc prepare,
 SourceFuncsCheckFunc check,
 SourceFuncsDispatchFunc dispatch,
 SourceFuncsFinalizeFunc finalize_,
 SourceFunc closureCallback,
 SourceDummyMarshal closureMarshal,
 Arena arena)

Allocate a new SourceFuncs with the fields set to the provided values.

Parameters:

prepare - value for the field prepare

check - value for the field check

dispatch - value for the field dispatch

finalize_ - value for the field finalize_

closureCallback - value for the field closureCallback

closureMarshal - value for the field closureMarshal

arena - to control the memory allocation scope

SourceFuncs

public SourceFuncs(SourceFuncsPrepareFunc prepare,
 SourceFuncsCheckFunc check,
 SourceFuncsDispatchFunc dispatch,
 SourceFuncsFinalizeFunc finalize_,
 SourceFunc closureCallback,
 SourceDummyMarshal closureMarshal)

Allocate a new SourceFuncs with the fields set to the provided values. The memory is allocated with Arena.ofAuto().

Parameters:

prepare - value for the field prepare

check - value for the field check

dispatch - value for the field dispatch

finalize_ - value for the field finalize_

closureCallback - value for the field closureCallback

closureMarshal - value for the field closureMarshal

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readPrepare

public SourceFuncsPrepareFunc readPrepare()

Read the value of the field prepare.

Returns:

The value of the field prepare

writePrepare

public void writePrepare(SourceFuncsPrepareFunc prepare,
 Arena _arena)

Write a value in the field prepare.

Parameters:

prepare - The new value for the field prepare

_arena - to control the memory allocation scope

readCheck

public SourceFuncsCheckFunc readCheck()

Read the value of the field check.

Returns:

The value of the field check

writeCheck

public void writeCheck(SourceFuncsCheckFunc check,
 Arena _arena)

Write a value in the field check.

Parameters:

check - The new value for the field check

_arena - to control the memory allocation scope

readDispatch

public SourceFuncsDispatchFunc readDispatch()

Read the value of the field dispatch.

Returns:

The value of the field dispatch

writeDispatch

public void writeDispatch(SourceFuncsDispatchFunc dispatch,
 Arena _arena)

Write a value in the field dispatch.

Parameters:

dispatch - The new value for the field dispatch

_arena - to control the memory allocation scope

readFinalize

public SourceFuncsFinalizeFunc readFinalize()

Read the value of the field finalize.

Returns:

The value of the field finalize

writeFinalize

public void writeFinalize(SourceFuncsFinalizeFunc finalize_,
 Arena _arena)

Write a value in the field finalize.

Parameters:

finalize_ - The new value for the field finalize

_arena - to control the memory allocation scope

readClosureCallback

public SourceFunc readClosureCallback()

Read the value of the field closure_callback.

Returns:

The value of the field closure_callback

writeClosureCallback

public void writeClosureCallback(SourceFunc closureCallback,
 Arena _arena)

Write a value in the field closure_callback.

Parameters:

closureCallback - The new value for the field closure_callback

_arena - to control the memory allocation scope

readClosureMarshal

public SourceDummyMarshal readClosureMarshal()

Read the value of the field closure_marshal.

Returns:

The value of the field closure_marshal

writeClosureMarshal

public void writeClosureMarshal(SourceDummyMarshal closureMarshal,
 Arena _arena)

Write a value in the field closure_marshal.

Parameters:

closureMarshal - The new value for the field closure_marshal

_arena - to control the memory allocation scope