Interface ServerCallback

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 ServerCallback
extends FunctionPointer

Functional interface declaration of the ServerCallback callback.

See Also:

• run(Server, ServerMessage, String, HashTable)

Method Summary

Modifier and Type	Method	Description
void	run(Server server, ServerMessage msg, String path, @Nullable HashTable<String,String> query)	A callback used to handle requests to a Server.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment, MemorySegment, MemorySegment) method.
default void	upcall(MemorySegment server, MemorySegment msg, MemorySegment path, MemorySegment query, MemorySegment userData)	The upcall method is called from native code.

Method Details

run

void run(Server server,
 ServerMessage msg,
 String path,
 @Nullable HashTable<String,String> query)

A callback used to handle requests to a Server.

path and query contain the likewise-named components of the Request-URI, subject to certain assumptions. By default, Server decodes all percent-encoding in the URI path, such that "/foo%2Fbar" is treated the same as "/foo/bar". If your server is serving resources in some non-POSIX-filesystem namespace, you may want to distinguish those as two distinct paths. In that case, you can set the Server:raw-paths property when creating the Server, and it will leave those characters undecoded.

query contains the query component of the Request-URI parsed according to the rules for HTML form handling. Although this is the only commonly-used query string format in HTTP, there is nothing that actually requires that HTTP URIs use that format; if your server needs to use some other format, you can just ignore query, and call Message.getUri() and parse the URI's query field yourself.

See Server.addHandler(String, ServerCallback) and Server.addEarlyHandler(String, ServerCallback) for details of what handlers can/should do.

Parameters:

server - the SoupServer

msg - the message being processed

path - the path component of msg's Request-URI

query - the parsed query component of msg's Request-URI

upcall

default void upcall(MemorySegment server,
 MemorySegment msg,
 MemorySegment path,
 MemorySegment query,
 MemorySegment userData)

The upcall method is called from native code. The parameters are marshaled and run(Server, ServerMessage, String, HashTable) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

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

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer