Package org.atmosphere.webtransport

Interface WebTransportProtocol

All Superinterfaces:

AtmosphereConfigAware

public interface WebTransportProtocol
extends AtmosphereConfigAware

Protocol for converting WebTransport messages into AtmosphereRequest objects that can be dispatched through the Atmosphere framework. Plays the role WebSocketProtocol plays for WebSocket: an implementation is selected by class name via ApplicationConfig.WEBTRANSPORT_PROTOCOL and, once installed, owns the session's message, lifecycle, and error callbacks. Unlike WebSocket there is no in-tree implementation — when the knob is unset the WebTransport processor bridges messages to the configured WebSocketProtocol machinery instead.

Method Summary

Modifier and Type	Method	Description
void	onClose(WebTransportSession session)	Invoked when a WebTransport session is closed.
void	onError(WebTransportSession session, WebTransportProcessor.WebTransportException t)	Invoked when an error occurs on the WebTransport session.
List<AtmosphereRequest>	onMessage(WebTransportSession session, byte[] data, int offset, int length)	Parse a binary message received on a WebTransport bidirectional stream and convert it to a list of AtmosphereRequest for dispatch.
List<AtmosphereRequest>	onMessage(WebTransportSession session, String data)	Parse a text message received on a WebTransport bidirectional stream and convert it to a list of AtmosphereRequest for dispatch.
void	onOpen(WebTransportSession session)	Invoked when a WebTransport session is opened.

Methods inherited from interface org.atmosphere.inject.AtmosphereConfigAware

configure

Method Details

onMessage

List<AtmosphereRequest> onMessage(WebTransportSession session,
 String data)

Parse a text message received on a WebTransport bidirectional stream and convert it to a list of AtmosphereRequest for dispatch.

Parameters:

session - the WebTransportSession

data - the text message

Returns:

a list of requests to dispatch, or null to handle dispatch manually

onMessage

List<AtmosphereRequest> onMessage(WebTransportSession session,
 byte[] data,
 int offset,
 int length)

Parse a binary message received on a WebTransport bidirectional stream and convert it to a list of AtmosphereRequest for dispatch.

Parameters:

session - the WebTransportSession

data - the raw bytes

offset - start offset

length - number of bytes

Returns:

a list of requests to dispatch, or null to handle dispatch manually

onOpen

void onOpen(WebTransportSession session)

Invoked when a WebTransport session is opened.

Parameters:

session - the WebTransportSession

onClose

void onClose(WebTransportSession session)

Invoked when a WebTransport session is closed.

Parameters:

session - the WebTransportSession

onError

void onError(WebTransportSession session,
 WebTransportProcessor.WebTransportException t)

Invoked when an error occurs on the WebTransport session.

Parameters:

session - the WebTransportSession

t - the exception