Package org.gnome.soup

Interface Message.AuthenticateCallback

All Superinterfaces:

FunctionPointer

Enclosing class:

Message

Functional Interface:

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

@FunctionalInterface
public static interface Message.AuthenticateCallback
extends FunctionPointer

Functional interface declaration of the AuthenticateCallback callback.

See Also:

• run(org.gnome.soup.Auth, boolean)

Method Summary

Modifier and Type	Method	Description
boolean	run(@Nullable Auth auth, boolean retrying)	Emitted when the message requires authentication.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, int) method.
default int	upcall(MemorySegment sourceMessage, MemorySegment auth, int retrying)	The upcall method is called from native code.

Method Details

run

boolean run(@Nullable Auth auth,
 boolean retrying)

Emitted when the message requires authentication.

If credentials are available call Auth.authenticate(java.lang.String, java.lang.String) on auth. If these credentials fail, the signal will be emitted again, with retrying set to true, which will continue until you return without calling Auth.authenticate(java.lang.String, java.lang.String) on auth.

Note that this may be emitted before msg's body has been fully read.

You can authenticate auth asynchronously by calling GObject.ref() on auth and returning true. The operation will complete once either Auth.authenticate(java.lang.String, java.lang.String) or Auth.cancel() are called.

upcall

default int upcall(MemorySegment sourceMessage,
 MemorySegment auth,
 int retrying)

The upcall method is called from native code. The parameters are marshaled and run(org.gnome.soup.Auth, boolean) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

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

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer