Package org.atmosphere.webtransport

Class WebTransportSession

java.lang.Object

org.atmosphere.cpr.AsyncIOWriterAdapter

org.atmosphere.cpr.AtmosphereInterceptorWriter

org.atmosphere.webtransport.WebTransportSession

All Implemented Interfaces:

AsyncIOWriter, KeepOpenStreamAware

public abstract class WebTransportSession
extends AtmosphereInterceptorWriter
implements KeepOpenStreamAware

Abstract representation of a WebTransport bidirectional stream session. Mirrors WebSocket for WebTransport over HTTP/3, backed by a single QUIC bidirectional stream.

Unlike WebSocket, there is no application-level ping/pong — QUIC handles keep-alive at the transport layer. Close codes use HTTP/3 error codes (0-255), not WebSocket codes (1000-4999).

Concrete implementations are provided by container modules (e.g., the Spring Boot starter's Reactor Netty integration).

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	binaryWrite
static final String	CLEAN_CLOSE
protected long	lastWrite
protected static final org.slf4j.Logger	logger
static final String	NOT_SUPPORTED
protected String	uuid
static final String	WEBTRANSPORT_INITIATED
static final String	WEBTRANSPORT_SUSPEND

Fields inherited from class org.atmosphere.cpr.AtmosphereInterceptorWriter

filters, reversedFilters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebTransportSession(AtmosphereConfig config)

Method Summary

Modifier and Type	Method	Description
Object	attachment()
WebTransportSession	attachment(Object attachment)
Map<String,Object>	attributes()
WebTransportSession	broadcast(Object o)	Broadcast an object to all sessions sharing this resource's Broadcaster.
abstract void	close()	Close the session.
void	close(int errorCode, String reason)	Close with an HTTP/3 error code and reason.
void	close(AtmosphereResponse r)	Close the underlying connection.
AtmosphereConfig	config()
WebTransportSession	flush(AtmosphereResponse r)	Flush the buffered content.
abstract boolean	isOpen()	Whether the underlying QUIC stream is still open.
long	lastWriteTimeStampInMilliseconds()
static void	notSupported(AtmosphereRequest request, AtmosphereResponse response)
WebTransportSession	redirect(AtmosphereResponse r, String location)	Redirect a WebSocket request to another location.
AtmosphereResource	resource()
WebTransportSession	resource(AtmosphereResource r)	Associate an AtmosphereResource with this session.
void	shiftAttributes()	Snapshot the request attributes that were set when the session opened.
protected byte[]	transform(AtmosphereResponse response, byte[] b, int offset, int length)
String	uuid()
WebTransportHandler	webTransportHandler()
protected WebTransportSession	webTransportHandler(WebTransportHandler handler)
WebTransportSession	write(byte[] b)	Write binary data to the bidirectional stream.
abstract WebTransportSession	write(byte[] b, int offset, int length)	Write binary data to the bidirectional stream.
abstract WebTransportSession	write(String s)	Write a text message to the bidirectional stream.
WebTransportSession	write(AtmosphereResponse r, byte[] data)	Write a WebSocket message.
WebTransportSession	write(AtmosphereResponse r, byte[] b, int offset, int length)	Write a WebSocket message.
WebTransportSession	write(AtmosphereResponse r, String data)	Write a WebSocket message.
WebTransportSession	writeError(AtmosphereResponse r, int errorCode, String message)	Write an error code.

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorWriter

filters, interceptor, interceptor, invokeInterceptor, writeReady

Methods inherited from class java.lang.Object

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

Field Details

logger

protected static final org.slf4j.Logger logger

WEBTRANSPORT_INITIATED

public static final String WEBTRANSPORT_INITIATED

WEBTRANSPORT_SUSPEND

public static final String WEBTRANSPORT_SUSPEND

NOT_SUPPORTED

public static final String NOT_SUPPORTED

See Also:

• Constant Field Values

CLEAN_CLOSE

public static final String CLEAN_CLOSE

See Also:

• Constant Field Values

lastWrite

protected long lastWrite

binaryWrite

protected boolean binaryWrite

uuid

protected String uuid

Constructor Details

WebTransportSession

protected WebTransportSession(AtmosphereConfig config)

Method Details

config

public AtmosphereConfig config()

webTransportHandler

protected WebTransportSession webTransportHandler(WebTransportHandler handler)

webTransportHandler

public WebTransportHandler webTransportHandler()

resource

public WebTransportSession resource(AtmosphereResource r)

Associate an AtmosphereResource with this session.

Parameters:

r - the resource

Returns:

this

resource

public AtmosphereResource resource()

shiftAttributes

public void shiftAttributes()

Snapshot the request attributes that were set when the session opened.

attributes

public Map<String,Object> attributes()

uuid

public String uuid()

lastWriteTimeStampInMilliseconds

public long lastWriteTimeStampInMilliseconds()

broadcast

public WebTransportSession broadcast(Object o)

Broadcast an object to all sessions sharing this resource's Broadcaster.

write

public WebTransportSession write(AtmosphereResponse r,
 String data)
                          throws IOException

Description copied from interface: AsyncIOWriter

Write a WebSocket message.

Specified by:

write in interface AsyncIOWriter

Overrides:

write in class AtmosphereInterceptorWriter

Parameters:

data - the WebSocket message

Throws:

IOException

write

public WebTransportSession write(AtmosphereResponse r,
 byte[] data)
                          throws IOException

Description copied from interface: AsyncIOWriter

Write a WebSocket message.

Specified by:

write in interface AsyncIOWriter

Overrides:

write in class AtmosphereInterceptorWriter

Parameters:

data - the WebSocket message

Throws:

IOException

write

public WebTransportSession write(AtmosphereResponse r,
 byte[] b,
 int offset,
 int length)
                          throws IOException

Description copied from interface: AsyncIOWriter

Write a WebSocket message.

Specified by:

write in interface AsyncIOWriter

Overrides:

write in class AtmosphereInterceptorWriter

Parameters:

b - the WebSocket message

offset - offset of the message

length - length of the message

Throws:

IOException

writeError

public WebTransportSession writeError(AtmosphereResponse r,
 int errorCode,
 String message)
                               throws IOException

Description copied from interface: AsyncIOWriter

Write an error code.

Specified by:

writeError in interface AsyncIOWriter

Overrides:

writeError in class AtmosphereInterceptorWriter

Parameters:

errorCode - the error code

message -

Throws:

IOException

redirect

public WebTransportSession redirect(AtmosphereResponse r,
 String location)
                             throws IOException

Description copied from interface: AsyncIOWriter

Redirect a WebSocket request to another location.

Specified by:

redirect in interface AsyncIOWriter

Overrides:

redirect in class AtmosphereInterceptorWriter

Parameters:

location -

Throws:

IOException

close

public void close(AtmosphereResponse r)
           throws IOException

Description copied from interface: AsyncIOWriter

Close the underlying connection.

Specified by:

close in interface AsyncIOWriter

Overrides:

close in class AtmosphereInterceptorWriter

Throws:

IOException

flush

public WebTransportSession flush(AtmosphereResponse r)
                          throws IOException

Description copied from interface: AsyncIOWriter

Flush the buffered content.

Specified by:

flush in interface AsyncIOWriter

Overrides:

flush in class AtmosphereInterceptorWriter

Throws:

IOException

notSupported

public static void notSupported(AtmosphereRequest request,
 AtmosphereResponse response)
                         throws IOException

Throws:

IOException

attachment

public WebTransportSession attachment(Object attachment)

attachment

public Object attachment()

transform

protected byte[] transform(AtmosphereResponse response,
 byte[] b,
 int offset,
 int length)
                    throws IOException

Throws:

IOException

isOpen

public abstract boolean isOpen()

Whether the underlying QUIC stream is still open.

write

public abstract WebTransportSession write(String s)
                                   throws IOException

Write a text message to the bidirectional stream.

Throws:

IOException

write

public abstract WebTransportSession write(byte[] b,
 int offset,
 int length)
                                   throws IOException

Write binary data to the bidirectional stream.

Throws:

IOException

write

public WebTransportSession write(byte[] b)
                          throws IOException

Write binary data to the bidirectional stream.

Throws:

IOException

close

public abstract void close()

Close the session.

close

public void close(int errorCode,
 String reason)

Close with an HTTP/3 error code and reason.

Parameters:

errorCode - HTTP/3 error code (0-255)

reason - human-readable reason