Package org.atmosphere.webtransport

Class WebTransportProcessorAdapter

java.lang.Object

org.atmosphere.webtransport.WebTransportProcessorAdapter

All Implemented Interfaces:

WebTransportProcessor

public class WebTransportProcessorAdapter
extends Object
implements WebTransportProcessor

No-op adapter for WebTransportProcessor. Used as the default when no container-specific implementation is available.

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.webtransport.WebTransportProcessor

WebTransportProcessor.WebTransportException, WebTransportProcessor.WebTransportHandlerProxy

Constructor Summary

Constructors

Constructor	Description
WebTransportProcessorAdapter()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebTransportProcessorAdapter

public WebTransportProcessorAdapter()

Method Details

configure

public WebTransportProcessor configure(AtmosphereConfig config)

Description copied from interface: WebTransportProcessor

Configure this processor.

Specified by:

configure in interface WebTransportProcessor

Parameters:

config - the AtmosphereConfig

Returns:

this

registerWebTransportHandler

public WebTransportProcessor registerWebTransportHandler(String path,
 WebTransportProcessor.WebTransportHandlerProxy handler)

Description copied from interface: WebTransportProcessor

Register a WebTransportHandler for a given path.

Specified by:

registerWebTransportHandler in interface WebTransportProcessor

Parameters:

path - the URI mapping

handler - a WebTransportProcessor.WebTransportHandlerProxy

Returns:

this

open

public void open(WebTransportSession session,
 AtmosphereRequest request,
 AtmosphereResponse response)

Description copied from interface: WebTransportProcessor

Invoked when a WebTransport session is opened.

Specified by:

open in interface WebTransportProcessor

Parameters:

session - the WebTransportSession

request - the initial AtmosphereRequest

response - the AtmosphereResponse

invokeWebTransportProtocol

public void invokeWebTransportProtocol(WebTransportSession session,
 String message)

Description copied from interface: WebTransportProcessor

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

Specified by:

invokeWebTransportProtocol in interface WebTransportProcessor

Parameters:

session - the WebTransportSession

message - the text message

invokeWebTransportProtocol

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

Description copied from interface: WebTransportProcessor

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

Specified by:

invokeWebTransportProtocol in interface WebTransportProcessor

Parameters:

session - the WebTransportSession

data - the raw bytes

offset - start offset

length - number of bytes

close

public void close(WebTransportSession session,
 int closeCode)

Description copied from interface: WebTransportProcessor

Invoked when the WebTransport session is closed.

Specified by:

close in interface WebTransportProcessor

Parameters:

session - the WebTransportSession

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

notifyListener

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

Description copied from interface: WebTransportProcessor

Notify all WebTransportEventListeners of an event.

Specified by:

notifyListener in interface WebTransportProcessor

Parameters:

session - the WebTransportSession

event - the event

destroy

public void destroy()

Description copied from interface: WebTransportProcessor

Destroy all resources associated with this processor.

Specified by:

destroy in interface WebTransportProcessor