Package org.gnome.glib

Interface LogWriterFunc

All Superinterfaces:

FunctionPointer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@Generated("io.github.jwharm.JavaGI")
public interface LogWriterFunc
extends FunctionPointer

Functional interface declaration of the LogWriterFunc callback.

See Also:

• run(java.util.Set<org.gnome.glib.LogLevelFlags>, org.gnome.glib.LogField[])

Method Summary

Modifier and Type	Method	Description
LogWriterOutput	run(Set<LogLevelFlags> logLevel, @Nullable LogField @Nullable [] fields)	Writer function for log entries.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(int, java.lang.foreign.MemorySegment, long, java.lang.foreign.MemorySegment) method.
default int	upcall(int logLevel, MemorySegment fields, long nFields, MemorySegment userData)	The upcall method is called from native code.

Method Details

run

LogWriterOutput run(Set<LogLevelFlags> logLevel,
 @Nullable LogField @Nullable [] fields)

Writer function for log entries. A log entry is a collection of one or more GLogFields, using the standard field names from journal specification. See g_log_structured() for more information.

Writer functions must ignore fields which they do not recognise, unless they can write arbitrary binary output, as field values may be arbitrary binary.

logLevel is guaranteed to be included in fields as the PRIORITY field, but is provided separately for convenience of deciding whether or where to output the log entry.

Writer functions should return LogWriterOutput.HANDLED if they handled the log message successfully or if they deliberately ignored it. If there was an error handling the message (for example, if the writer function is meant to send messages to a remote logging server and there is a network error), it should return LogWriterOutput.UNHANDLED. This allows writer functions to be chained and fall back to simpler handlers in case of failure.

Since:

2.50

upcall

default int upcall(int logLevel,
 MemorySegment fields,
 long nFields,
 MemorySegment userData)

The upcall method is called from native code. The parameters are marshaled and run(java.util.Set<org.gnome.glib.LogLevelFlags>, org.gnome.glib.LogField[]) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(int, java.lang.foreign.MemorySegment, long, java.lang.foreign.MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer