Package org.atmosphere.container

Class BlockingIOCometSupport

java.lang.Object

org.atmosphere.cpr.AsynchronousProcessor

org.atmosphere.container.BlockingIOCometSupport

All Implemented Interfaces:

AsyncSupport<AtmosphereResourceImpl>

public class BlockingIOCometSupport
extends AsynchronousProcessor

This class is used when the AtmosphereFramework fails to autodetect the Servlet Container we are running on.

This AsyncSupport implementation uses a blocking approach, meaning the request thread will be blocked until another Thread invoke the Broadcaster.broadcast(java.lang.Object).

Suspend timeout: a suspended request waits for the suspend timeout the application set (Action.timeout()); a timeout of -1 waits until the resource is resumed or cancelled. There is no container-level default timeout.

Virtual threads: the wait parks the calling thread on a CountDownLatch, which unmounts a virtual thread rather than pinning its carrier, so one virtual thread per suspended connection is viable (BlockingIOCometSupportVirtualThreadTest).

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	LATCH

Fields inherited from class org.atmosphere.cpr.AsynchronousProcessor

cancelledAction, config, timedoutAction

Constructor Summary

Constructors

Constructor	Description
BlockingIOCometSupport(AtmosphereConfig config)

Method Summary

Modifier and Type	Method	Description
void	action(AtmosphereResourceImpl r)	Process an Action from an ActionEvent operation like suspend, resume or timed out.
Action	cancelled(AtmosphereRequest req, AtmosphereResponse res)	All proprietary Comet based Servlet must invoke the cancelled method when the underlying WebServer detect that the client closed the connection.
AsyncSupport<AtmosphereResourceImpl>	complete(AtmosphereResourceImpl r)	Complete and close the connection associated with an implementation of AtmosphereResource
Action	service(AtmosphereRequest req, AtmosphereResponse res)	Serve the AtmosphereRequest and the AtmosphereResponse and return the appropriate Action.
protected void	suspend(Action action, AtmosphereRequest req, AtmosphereResponse res)	Suspend the connection by blocking the current Thread

Methods inherited from class org.atmosphere.cpr.AsynchronousProcessor

allowSessionTimeoutRemoval, completeLifecycle, endRequest, getContainerName, init, invokeAtmosphereHandler, invokeInterceptors, map, postInterceptors, resumed, shutdown, supportSession, supportWebSocket, suspended, timedout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.atmosphere.cpr.AsyncSupport

supportWebTransport

Field Details

LATCH

protected static final String LATCH

Constructor Details

BlockingIOCometSupport

public BlockingIOCometSupport(AtmosphereConfig config)

Method Details

service

public Action service(AtmosphereRequest req,
 AtmosphereResponse res)
               throws IOException,
ServletException

Description copied from interface: AsyncSupport

Serve the AtmosphereRequest and the AtmosphereResponse and return the appropriate Action.

Parameters:

req - the AtmosphereRequest

res - the AtmosphereResponse

Returns:

the Action that was manipulated by the AtmosphereHandler

Throws:

IOException

ServletException

suspend

protected void suspend(Action action,
 AtmosphereRequest req,
 AtmosphereResponse res)
                throws IOException,
ServletException

Suspend the connection by blocking the current Thread

Parameters:

action - The Action

req - the AtmosphereRequest

res - the AtmosphereResponse

Throws:

IOException

ServletException

cancelled

public Action cancelled(AtmosphereRequest req,
 AtmosphereResponse res)
                 throws IOException,
ServletException

Description copied from class: AsynchronousProcessor

All proprietary Comet based Servlet must invoke the cancelled method when the underlying WebServer detect that the client closed the connection.

Overrides:

cancelled in class AsynchronousProcessor

Parameters:

req - the AtmosphereRequest

res - the AtmosphereResponse

Returns:

action the Action operation.

Throws:

IOException

ServletException

action

public void action(AtmosphereResourceImpl r)

Description copied from interface: AsyncSupport

Process an Action from an ActionEvent operation like suspend, resume or timed out.

Specified by:

action in interface AsyncSupport<AtmosphereResourceImpl>

Overrides:

action in class AsynchronousProcessor

Parameters:

r - An instance of Action

complete

public AsyncSupport<AtmosphereResourceImpl> complete(AtmosphereResourceImpl r)

Description copied from interface: AsyncSupport

Complete and close the connection associated with an implementation of AtmosphereResource

Specified by:

complete in interface AsyncSupport<AtmosphereResourceImpl>

Overrides:

complete in class AsynchronousProcessor

Parameters:

r - AtmosphereResource

Returns:

this