Package org.atmosphere.cpr

Interface Summary

Interface	Description
AnnotationProcessor	An annotation processor for configuring the AtmosphereFramework
ApplicationConfig	Web.xml init-param configuration supported by Atmosphere.
AsyncIOInterceptor	A filter like API that allow an AtmosphereInterceptor to intercept the response before it get written back to the client.
AsyncIOWriter	An Asynchronous I/O Writer is used by a AtmosphereResponse when writing data.
AsyncSupport<E extends AtmosphereResource>	Atmosphere's supported WebServer must implement this interface in order to be auto detected by the AtmosphereFramework.
AsyncSupportListener	A listener that can be used to track AsyncSupport events like SUSPEND, RESUME, TIMEOUT, DESTROYED and CLOSED
AsyncSupportResolver	This interface is used by AtmosphereFramework to determine which AsyncSupport instance should be used
AtmosphereHandler	Implementation of AtmosphereHandler allows creation of event-driven web applications which are hosted in the browser.
AtmosphereInterceptor	Intercept the dispatch of AtmosphereResource before they get dispatched to AtmosphereHandlers.
AtmosphereResource	A AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended response.
AtmosphereResourceEvent	An AtmosphereResourceEvent is created every time an event occurs like when a Broadcaster.broadcast(java.lang.Object) is executed, when a Browser close remotely close the connection or when a suspended times out or gets resumed.
AtmosphereResourceEventListener	Receive notification when a resume, client disconnect or broadcast events occurs.
AtmosphereServletProcessor	Simple interface that can be used to wrap a Servlet from an AtmosphereHandler
Broadcaster	A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResource, which are representing a suspended response.
BroadcasterCache	A BroadcasterCache is used to persist broadcasted Object Broadcaster.broadcast(Object).
BroadcasterLifeCyclePolicyListener	Simple listener to be used to track BroadcasterLifeCyclePolicy events.
BroadcasterListener	A listener for Broadcaster events lifecycle
BroadcastFilter	Transform a message before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).
BroadcastFilterLifecycle	Add lifecycle method to the BroadcastFilter interface.
ClusterBroadcastFilter	Specialize BroadcastFilter used when clustering is enabled.
FrameworkConfig	Request Attribute a framework integrator can use to lookup Atmosphere internal object.
HeaderConfig	This interface contains all Atmosphere headers shared between the client and the server.
PerRequestBroadcastFilter	An extended BroadcastFilter that can vbe used to filter based on AtmosphereResource
Serializer	Serialize the Object the result of invoking Broadcaster.broadcast(T).

Class Summary

Class	Description
Action	An Action is used by AtmosphereInterceptor, AsyncSupport and AtmosphereFramework to determine what to do with a request, e.g suspend it, resume it, etc.
AsynchronousProcessor	Base class which implement the semantics of suspending and resuming of a Comet/WebSocket Request.
AsynchronousProcessor.AsynchronousProcessorHook	An Callback class that can be used by Framework integrator to handle the close/timedout/resume life cycle of an AtmosphereResource.
AsyncIOWriterAdapter	Adapter class for AsyncIOWriter.
AsyncSupportListenerAdapter	A default implementation of AsyncSupportListener
AtmosphereConfig
AtmosphereFilter	Atmosphere supports for Filter, delegating all works to AtmosphereServlet.
AtmosphereFramework	The AtmosphereFramework is the entry point for the framework.
AtmosphereFramework.AtmosphereHandlerWrapper
AtmosphereInterceptorAdapter	A Simple AtmosphereInterceptor that creates an AtmosphereInterceptorWriter and set it as the default AsyncIOWriter on an AtmosphereResponse
AtmosphereInterceptorWriter	An AsyncIOWriter that delegates the write operation to it's AsyncIOInterceptor.
AtmosphereRequest	An Atmosphere request representation.
AtmosphereRequest.Builder
AtmosphereResourceEventImpl	AtmosphereResourceEvent implementation for Servlet Container.
AtmosphereResourceEventListenerAdapter	An implementation of AtmosphereResourceEventListener with just log event as trace.
AtmosphereResourceFactory	A Factory used to manage AtmosphereResource instance.
AtmosphereResourceImpl	AtmosphereResource implementation for supporting AtmosphereRequest and AtmosphereResponse.
AtmosphereResponse	An Atmosphere's response representation.
AtmosphereResponse.Builder
AtmosphereServlet	The AtmosphereServlet acts as a dispatcher for AtmosphereHandler defined in META-INF/atmosphere.xml, or if atmosphere.xml is missing, all classes that implements AtmosphereHandler will be discovered and mapped using the class's name.
AtmosphereServlet30	AtmosphereServlet for Servlet 3.0 only Container
BroadcasterConfig	Handle Broadcaster configuration like ExecutorService and BroadcastFilter
BroadcasterConfig.DefaultBroadcasterCache
BroadcasterFactory	Broadcaster factory used by Atmosphere when creating broadcaster.
BroadcasterFuture<E>	Simple Future that can be used when awaiting for a Broadcaster to finish it's broadcast operations to AtmosphereHandler
BroadcasterLifeCyclePolicy	This class can be used to configure the life cycle of a Broadcaster, e.g when a broadcaster gets destroyed Broadcaster.destroy() or when it's associated resources get released Broadcaster.releaseExternalResources().
BroadcasterLifeCyclePolicy.Builder
BroadcasterLifeCyclePolicyListenerAdapter	Simple adapter listener to be used to track BroadcasterLifeCyclePolicy events.
BroadcastFilter.BroadcastAction	Simple class that tells the Broadcaster to broadcast or not the transformed value.
DefaultAnnotationProcessor	An AnnotationProcessor based on
DefaultAsyncSupportResolver	This is the default implementation of @link {AsyncSupportResolver}
DefaultBroadcaster	Broadcaster implementation.
DefaultBroadcaster.AsyncWriteToken
DefaultBroadcaster.Entry
DefaultBroadcasterFactory	This class is responsible for creating Broadcaster instance.
MetaBroadcaster	Broadcast events to all or a subset of available Broadcaster based on theirBroadcaster.getID() value.
Meteor	A Meteor is a simple class that can be used from a Servlet to suspend, broadcast and resume a response.
MeteorServlet	Simple Servlet to use when Atmosphere Meteor are used.
SessionSupport
SessionTimeoutRestorer	Capable of restoring HTTP session timeout to given value.
SessionTimeoutSupport	Allows invalidating and restoring HTTP session timeout.
WebSocketProcessorFactory	Factory for WebSocketProcessor.

Enum Summary

Enum	Description
Action.TYPE	The action's type.
AtmosphereResource.TRANSPORT
Broadcaster.POLICY
Broadcaster.SCOPE
BroadcasterCache.STRATEGY
BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY
BroadcastFilter.BroadcastAction.ACTION

Exception Summary

Exception	Description
AtmosphereMappingException	Throw when AsynchronousProcessor is unable to map the request to an AtmosphereHandler
DefaultBroadcasterFactory.BroadcasterCreationException