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 gets 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
AtmosphereConfig.ShutdownHook	A shutdown hook that will be called when the AtmosphereFramework.destroy() method gets invoked.
AtmosphereConfig.StartupHook	A Startup hook that will be called when the AtmosphereFramework.init() method complete.
AtmosphereFrameworkListener	Lifecycle listener for AtmosphereFramework
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.
AtmosphereObjectFactory<Z>	Customization point for Atmosphere to instantiate classes.
AtmosphereRequest	An Atmosphere request representation.
AtmosphereRequest.Builder
AtmosphereResource	An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
AtmosphereResourceEvent	An AtmosphereResourceEvent is created every time an event occurs, like when a Broadcaster.broadcast(java.lang.Object) is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.
AtmosphereResourceEventListener	Receive notifications when resume, client disconnect or broadcast events occur.
AtmosphereResourceFactory	A Factory used to manage AtmosphereResource instances.
AtmosphereResourceFactory.Async	An interface to use in order to retrieve an AtmosphereResource inside a cluster.
AtmosphereResourceHeartbeatEventListener	Receive notifications when heartbeat events occur.
AtmosphereResourceListener	Listener for when AtmosphereResource gets suspended and disconnected.
AtmosphereResourceSession	The AtmosphereResourceSession is managed by the AtmosphereResourceSessionFactory.
AtmosphereResourceSessionFactory	Factory for AtmosphereResourceSession instances
AtmosphereResponse	An Atmosphere's response representation.
AtmosphereResponse.Builder
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 AtmosphereResources, which are representing suspended responses.
BroadcasterCache	A BroadcasterCache is a cache for broadcasted messages.
BroadcasterCacheListener	Listener for BroadcasterCache
BroadcasterConfig.FilterManipulator	Manipulate the message before and after they are getting filtered by BroadcastFilter
BroadcasterFactory	Factory for Broadcaster used by Atmosphere when creating broadcasters.
BroadcasterLifeCyclePolicyListener	Simple listener to be used to track BroadcasterLifeCyclePolicy events.
BroadcasterListener	A listener for a Broadcaster's event 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.
CompletionAware	The CompletionAware interface is used by a class implementing the AtmosphereResponse interface to be notified when writing to the response has been completed.
FrameworkConfig	Request attribute a framework integrator can use to lookup Atmosphere internal objects.
HeaderConfig	This interface contains all Atmosphere headers shared between the client and the server.
KeepOpenStreamAware	The KeepOpenStreamAware interface is used by a class implementing the AsyncIOWriter interface to indicate the closing of the underlining stream is managed elsewhere and invoking the AsyncIOWriter.close(AtmosphereResponse) method does not close the stream.
MetaBroadcaster	Broadcast events to all or a subset of available Broadcasters based on their Broadcaster.getID() value.
MetaBroadcaster.MetaBroadcasterCache	Cache message if no Broadcaster maps the MetaBroadcaster.broadcastTo(String, Object)
PerRequestBroadcastFilter	An extended BroadcastFilter that can be used to filter based on AtmosphereResource.
Serializer	Serialize the Object that was used as parameter to Broadcaster.broadcast(java.lang.Object).

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.
AnnotationHandler	A class that handles the results of an annotation scan.
AnnotationScanningServletContainerInitializer	A ServletContainerInitializer that scans for annotations, and places them in a map keyed by annotation type in the servlet context.
AsynchronousProcessor	Base class which implement the semantics of suspending and resuming of a Comet/WebSocket Request.
AsyncIOInterceptorAdapter	An Adapter for AsyncIOInterceptor.
AsyncIOWriterAdapter	Adapter class for AsyncIOWriter.
AsyncSupportListenerAdapter	A default implementation of AsyncSupportListener
AtmosphereConfig	This class contains information about the current state of the AtmosphereFramework.
AtmosphereFilter	Atmosphere has support for Filters, delegating all work to AtmosphereServlet.
AtmosphereFramework	The AtmosphereFramework is the entry point for the framework.
AtmosphereFramework.AtmosphereHandlerWrapper
AtmosphereFramework.DefaultAtmosphereObjectFactory
AtmosphereFrameworkInitializer
AtmosphereFrameworkListenerAdapter	Adapter for AtmosphereFrameworkListener
AtmosphereInterceptorAdapter	A Simple AtmosphereInterceptor that creates an AtmosphereInterceptorWriter and sets it as the default AsyncIOWriter on an AtmosphereResponse.
AtmosphereInterceptorWriter	An AsyncIOWriter that delegates the write operation to its AsyncIOInterceptor.
AtmosphereRequest.LocalAttributes
AtmosphereRequestImpl	An Atmosphere request representation.
AtmosphereRequestImpl.Body
AtmosphereRequestImpl.Builder
AtmosphereRequestImpl.LazyComputation
AtmosphereRequestImpl.NoOpsRequest
AtmosphereResourceEventImpl	AtmosphereResourceEvent implementation.
AtmosphereResourceEventListenerAdapter	An implementation of AtmosphereResourceEventListener which just log events with log level TRACE.
AtmosphereResourceEventListenerAdapter.OnBroadcast	On Broadcast's Listener
AtmosphereResourceEventListenerAdapter.OnClose	On Close's Listener
AtmosphereResourceEventListenerAdapter.OnDisconnect	On Disconnect's Listener
AtmosphereResourceEventListenerAdapter.OnHeartbeat	On Heartbeat's Listener
AtmosphereResourceEventListenerAdapter.OnPreSuspend	On PreSuspend's Listener
AtmosphereResourceEventListenerAdapter.OnResume	On Resume's Listener
AtmosphereResourceEventListenerAdapter.OnSuspend	On Suspend's Listener
AtmosphereResourceEventListenerAdapter.OnThrowable	On Throwable's Listener
AtmosphereResourceImpl	AtmosphereResource implementation for supporting AtmosphereRequest and AtmosphereResponse.
AtmosphereResourceListenerAdapter	Adapter for AtmosphereResourceListener
AtmosphereResponseImpl	An Atmosphere's response representation.
AtmosphereResponseImpl.Builder
AtmosphereServlet	AtmosphereServlet that use Servlet 3.0 Async API when available, and fallback to native comet support if not available.
AtmosphereSession	An AtmosphereSession allow an application to keep track of the AtmosphereResource associated with a remote client.
BroadcasterConfig	Handle Broadcaster configuration like ExecutorService and BroadcastFilter.
BroadcasterFuture<E>	Simple Future that can be used when awaiting for a Broadcaster to finish its broadcast operation to AtmosphereHandler.
BroadcasterLifeCyclePolicy	This class can be used to configure the life cycle of a Broadcaster, eg.
BroadcasterLifeCyclePolicy.Builder
BroadcasterLifeCyclePolicyListenerAdapter	Simple adapter listener to be used to track BroadcasterLifeCyclePolicy events.
BroadcasterListenerAdapter	An implementation of BroadcasterListener.
BroadcastFilter.BroadcastAction	Simple class that tells the Broadcaster to broadcast or not the transformed value.
BroadcastFilterAdapter	Adapter for PerRequestBroadcastFilter.
ContainerInitializer	Initializer for the AtmosphereFramework per servlet instance, this initializer is called during web-application startup lifecycle (since Servlet 3.0).
DefaultAnnotationProcessor	An AnnotationProcessor that selects between a ServletContextInitializer based scanner, and a bytecode based scanner based on .
DefaultAsyncSupportResolver	This is the default implementation of @link {AsyncSupportResolver}.
DefaultAtmosphereResourceFactory	A Factory used to manage AtmosphereResource instances.
DefaultAtmosphereResourceSession
DefaultAtmosphereResourceSessionFactory
DefaultBroadcaster	The default Broadcaster implementation.
DefaultBroadcaster.AsyncWriteToken
DefaultBroadcaster.WriteQueue
DefaultBroadcasterFactory	This class is responsible for creating Broadcaster instances.
DefaultMetaBroadcaster	Broadcast events to all or a subset of available Broadcasters based on their Broadcaster.getID() value.
Deliver	A Deliver is an Broadcaster's internal token that is created before the message gets Broadcaster.
HeartbeatAtmosphereResourceEvent	Specifies to the observable that AtmosphereResourceHeartbeatEventListener.onHeartbeat(org.atmosphere.cpr.AtmosphereResourceEvent) should be invoked when it fires event to observers.
MetaBroadcaster.NoCache
MetaBroadcaster.ThirtySecondsCache	Flush the cache every 30 seconds.
Meteor	A Meteor is a simple class that can be used from a Servlet to suspend, broadcast and resume responses.
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.
Universe	Universe contains static reference to Atmosphere's Factories.
WebSocketProcessorFactory	Factory for WebSocketProcessor.

Enum Summary

Enum	Description
Action.TYPE	The action's type.
AtmosphereFramework.MetaServiceAction	This enumeration represents all possible actions to specify in a meta service file.
AtmosphereResource.TRANSPORT
Broadcaster.POLICY
Broadcaster.SCOPE
BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY
BroadcastFilter.BroadcastAction.ACTION
Deliver.TYPE

Exception Summary

Exception	Description
AtmosphereMappingException	Thrown when AsynchronousProcessor is unable to map the request to an AtmosphereHandler.
BroadcasterFactory.BroadcasterCreationException
BroadcasterListener.BroadcastListenerException	Throw this exception to interrupt the Broadcaster.destroy() operation.