Package org.atmosphere.webtransport

Interface WebTransportProcessor

All Known Implementing Classes:

WebTransportProcessorAdapter

public interface WebTransportProcessor

WebTransport processing SPI. Mirrors WebSocketProcessor but without servlet handshake validation (WebTransport uses HTTP/3 extended CONNECT, validated at the Reactor Netty level) and without InputStream/Reader overloads (QUIC streams are natively byte-oriented).

The default implementation lives in the Spring Boot starter module since it requires Reactor Netty. The SPI here is transport-agnostic.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WebTransportProcessor.WebTransportException	Exception type for WebTransport processing errors.
static final class	WebTransportProcessor.WebTransportHandlerProxy	Proxy that associates a WebTransportHandler with a Broadcaster class, mirroring WebSocketProcessor.WebSocketHandlerProxy.

Method Summary

Modifier and Type	Method	Description
void	close(WebTransportSession session, int closeCode)	Invoked when the WebTransport session is closed.
WebTransportProcessor	configure(AtmosphereConfig config)	Configure this processor.
void	destroy()	Destroy all resources associated with this processor.
void	invokeWebTransportProtocol(WebTransportSession session, byte[] data, int offset, int length)	Invoked when a binary message is received on a bidirectional stream.
void	invokeWebTransportProtocol(WebTransportSession session, String message)	Invoked when a text message is received on a bidirectional stream.
void	notifyListener(WebTransportSession session, WebTransportEventListener.WebTransportEvent<?> event)	Notify all WebTransportEventListeners of an event.
void	open(WebTransportSession session, AtmosphereRequest request, AtmosphereResponse response)	Invoked when a WebTransport session is opened.
WebTransportProcessor	registerWebTransportHandler(String path, WebTransportProcessor.WebTransportHandlerProxy handler)	Register a WebTransportHandler for a given path.

Method Details

configure

WebTransportProcessor configure(AtmosphereConfig config)

Configure this processor.

Parameters:

config - the AtmosphereConfig

Returns:

this

registerWebTransportHandler

WebTransportProcessor registerWebTransportHandler(String path,
 WebTransportProcessor.WebTransportHandlerProxy handler)

Register a WebTransportHandler for a given path.

Parameters:

path - the URI mapping

handler - a WebTransportProcessor.WebTransportHandlerProxy

Returns:

this

open

void open(WebTransportSession session,
 AtmosphereRequest request,
 AtmosphereResponse response)
   throws IOException

Invoked when a WebTransport session is opened.

Parameters:

session - the WebTransportSession

request - the initial AtmosphereRequest

response - the AtmosphereResponse

Throws:

IOException

invokeWebTransportProtocol

void invokeWebTransportProtocol(WebTransportSession session,
 String message)

Invoked when a text message is received on a bidirectional stream.

Parameters:

session - the WebTransportSession

message - the text message

invokeWebTransportProtocol

void invokeWebTransportProtocol(WebTransportSession session,
 byte[] data,
 int offset,
 int length)

Invoked when a binary message is received on a bidirectional stream.

Parameters:

session - the WebTransportSession

data - the raw bytes

offset - start offset

length - number of bytes

close

void close(WebTransportSession session,
 int closeCode)

Invoked when the WebTransport session is closed.

Parameters:

session - the WebTransportSession

closeCode - the HTTP/3 error code (0-255)

notifyListener

void notifyListener(WebTransportSession session,
 WebTransportEventListener.WebTransportEvent<?> event)

Notify all WebTransportEventListeners of an event.

Parameters:

session - the WebTransportSession

event - the event

destroy

void destroy()

Destroy all resources associated with this processor.