Interface FileProgressCallback

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("org.javagi.JavaGI")
public interface FileProgressCallback
extends FunctionPointer

Functional interface declaration of the FileProgressCallback callback.

See Also:

• run(long, long, MemorySegment)

Method Summary

Modifier and Type	Method	Description
void	run(long currentNumBytes, long totalNumBytes, @Nullable MemorySegment data)	When doing file operations that may take a while, such as moving a file or copying a file, a progress callback is used to pass how far along that operation is to the application.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(long, long, MemorySegment) method.
default void	upcall(long currentNumBytes, long totalNumBytes, MemorySegment data)	The upcall method is called from native code.

Method Details

run

void run(long currentNumBytes,
 long totalNumBytes,
 @Nullable MemorySegment data)

When doing file operations that may take a while, such as moving a file or copying a file, a progress callback is used to pass how far along that operation is to the application.

Parameters:

currentNumBytes - the current number of bytes in the operation.

totalNumBytes - the total number of bytes in the operation.

data - user data passed to the callback.

upcall

default void upcall(long currentNumBytes,
 long totalNumBytes,
 MemorySegment data)

The upcall method is called from native code. The parameters are marshaled and run(long, long, MemorySegment) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(long, long, MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer