Interface ServerWebsocketCallback

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

Functional interface declaration of the ServerWebsocketCallback callback.

See Also:

• run(Server, ServerMessage, String, WebsocketConnection)

Method Summary

Modifier and Type	Method	Description
void	run(Server server, ServerMessage msg, String path, WebsocketConnection connection)	A callback used to handle WebSocket 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 connection, MemorySegment userData)	The upcall method is called from native code.

Method Details

run

void run(Server server,
 ServerMessage msg,
 String path,
 WebsocketConnection connection)

A callback used to handle WebSocket requests to a Server.

The callback will be invoked after sending the handshake response back to the client (and is only invoked if the handshake was successful).

path contains the path of the Request-URI, subject to the same rules as ServerCallback (qv).

Parameters:

server - the SoupServer

msg - the SoupServerMessage

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

connection - the newly created WebSocket connection

upcall

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

The upcall method is called from native code. The parameters are marshaled and run(Server, ServerMessage, String, WebsocketConnection) 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