Meteor (atmosphere-runtime 2.0.12 API)

java.lang.Object
- org.atmosphere.cpr.Meteor

```
public class Meteor
extends java.lang.Object
```
A Meteor is a simple class that can be used from a Servlet to suspend, broadcast and resume responses. A Meteor can be created by invoking the build() method.
Meteor.build(HttpServletRequest).suspend(-1);
A Meteor is usually created when an application needs to suspend a response. A Meteor instance can then be cached and re-used later for either broadcasting a message, or when an application needs to resume the suspended response.

Author:

Jeanfrancois Arcand

Method Summary

Methods
Modifier and Type	Method and Description
`Meteor`	`addListener(AtmosphereResourceEventListener e)` Add a `AtmosphereResourceEventListener` which gets invoked when responses are resuming, when the remote client closes the connection or when the a `Broadcaster.broadcast(java.lang.Object)` operations occurs.
`void`	`attach(java.lang.Object o)` Attach an `Object` with this `Meteor`.
`java.lang.Object`	`attachement()` Return an `Object` with this `Meteor`.
`Meteor`	`broadcast(java.lang.Object o)` Broadcast an `Object` to all suspended responses.
`static Meteor`	`build(javax.servlet.http.HttpServletRequest r)` Create a `Meteor` using the `HttpServletRequest`.
`static Meteor`	`build(javax.servlet.http.HttpServletRequest req, Broadcaster.SCOPE scope, java.util.List<BroadcastFilter> l, Serializer s)` Create a `Meteor` using the `HttpServletRequest` and use a list of `BroadcastFilter` and `Serializer` for writing the result of a broadcast operation the `HttpServletResponse`.
`static Meteor`	`build(javax.servlet.http.HttpServletRequest req, java.util.List<BroadcastFilter> l, Serializer s)` Create a `Meteor` using the `HttpServletRequest` and use a list of `BroadcastFilter` and `Serializer` for writing the result of a broadcast operation the `HttpServletResponse`.
`static Meteor`	`build(javax.servlet.http.HttpServletRequest r, Serializer s)` Create a `Meteor` using the `HttpServletRequest` and use the `Serializer` for writing the result of a broadcast operation using the `HttpServletResponse`.
`Meteor`	`delayBroadadcast(java.lang.Object o, long period)` Schedule a delayed broadcast, in seconds.
`void`	`destroy()` Mark this instance as destroyed.
`AtmosphereResource`	`getAtmosphereResource()` Return the underlying `AtmosphereResource`.
`Broadcaster`	`getBroadcaster()` Return the underlying `Broadcaster`.
`static Meteor`	`lookup(javax.servlet.http.HttpServletRequest r)` Retrieve an instance of `Meteor` based on the `HttpServletRequest`.
`Meteor`	`removeListener(AtmosphereResourceEventListener e)` Remove a `AtmosphereResourceEventListener` which gets invoked when a response is resuming, when the remote client closes the connection or when the a `Broadcaster.broadcast(java.lang.Object)` operations occurs.
`Meteor`	`resume()` Resume the underlying `HttpServletResponse`.
`Meteor`	`resumeOnBroadcast(boolean resumeOnBroadcast)` Resume the Meteor after the first broadcast operation.
`Meteor`	`schedule(java.lang.Object o, long period)` Schedule a periodic broadcast, in seconds.
`void`	`setBroadcaster(Broadcaster b)` Set a `Broadcaster` instance.
`Meteor`	`suspend(long l)` Suspend the underlying `HttpServletResponse`.
`Meteor`	`suspend(long timeout, java.util.concurrent.TimeUnit timeunit)` Suspend the underlying `HttpServletResponse`.
`AtmosphereResource.TRANSPORT`	`transport()` Return the current `AtmosphereResource.TRANSPORT`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - lookup
```
public static Meteor lookup(javax.servlet.http.HttpServletRequest r)
```
    Retrieve an instance of Meteor based on the HttpServletRequest.
    
    Parameters:
    r - HttpServletRequest
    
    Returns:
    a Meteor or null if not found
  - build
```
public static final Meteor build(javax.servlet.http.HttpServletRequest r)
```
    Create a Meteor using the HttpServletRequest.
    
    Parameters:
    r - an HttpServletRequest
    
    Returns:
    a Meteor than can be used to resume, suspend and broadcast Object
  - build
```
public static final Meteor build(javax.servlet.http.HttpServletRequest r,
           Serializer s)
```
    Create a Meteor using the HttpServletRequest and use the Serializer for writing the result of a broadcast operation using the HttpServletResponse.
    
    Parameters:
    r - an HttpServletRequest
    s - a Serializer used when writing broadcast events
    
    Returns:
    a Meteor than can be used to resume, suspend and broadcast Object
  - build
```
public static final Meteor build(javax.servlet.http.HttpServletRequest req,
           java.util.List<BroadcastFilter> l,
           Serializer s)
```
    Create a Meteor using the HttpServletRequest and use a list of BroadcastFilter and Serializer for writing the result of a broadcast operation the HttpServletResponse.
    
    Parameters:
    req - an HttpServletRequest
    l - a list of BroadcastFilter
    s - a Serializer used when writing broadcast events
    
    Returns:
    a Meteor than can be used to resume, suspend and broadcast Object
  - build
```
public static final Meteor build(javax.servlet.http.HttpServletRequest req,
           Broadcaster.SCOPE scope,
           java.util.List<BroadcastFilter> l,
           Serializer s)
```
    Create a Meteor using the HttpServletRequest and use a list of BroadcastFilter and Serializer for writing the result of a broadcast operation the HttpServletResponse.
    
    Parameters:
    req - an HttpServletRequest
    scope - the Broadcaster.SCOPE}
    l - a list of BroadcastFilter
    s - a Serializer used when writing broadcast events
    
    Returns:
    a Meteor than can be used to resume, suspend and broadcast Object
  - suspend
```
public Meteor suspend(long l)
```
    Suspend the underlying HttpServletResponse. Passing a value of -1 suspends the response forever.
    
    Parameters:
    l - the maximum time a response stay suspended
    
    Returns:
    Meteor
  - resumeOnBroadcast
```
public Meteor resumeOnBroadcast(boolean resumeOnBroadcast)
```
    Resume the Meteor after the first broadcast operation. This is useful when long-polling is used.
    
    Parameters:
    resumeOnBroadcast -
    
    Returns:
    this
  - transport
```
public AtmosphereResource.TRANSPORT transport()
```
    Return the current AtmosphereResource.TRANSPORT. The transport needs to be explicitly set by the client by adding the appropriate HeaderConfig.X_ATMOSPHERE_TRANSPORT value, which can be long-polling, streaming, websocket or JSONP.
    
    Returns:
  - suspend
```
public Meteor suspend(long timeout,
             java.util.concurrent.TimeUnit timeunit)
```
    Suspend the underlying HttpServletResponse. Passing a value of -1 suspends the response forever.
    
    Parameters:
    timeout - the maximum time a response stay suspended
    timeunit - The time unit of the timeout value
    
    Returns:
    Meteor
  - resume
```
public Meteor resume()
```
    Resume the underlying HttpServletResponse.
    
    Returns:
    Meteor
  - broadcast
```
public Meteor broadcast(java.lang.Object o)
```
    Broadcast an Object to all suspended responses.
    
    Parameters:
    o - an Object
    
    Returns:
    Meteor
  - schedule
```
public Meteor schedule(java.lang.Object o,
              long period)
```
    Schedule a periodic broadcast, in seconds.
    
    Parameters:
    o - an Object
    period - period in seconds
    
    Returns:
    Meteor
  - delayBroadadcast
```
public Meteor delayBroadadcast(java.lang.Object o,
                      long period)
```
    Schedule a delayed broadcast, in seconds.
    
    Parameters:
    o - an Object
    period - period in seconds
    
    Returns:
    Meteor
  - getBroadcaster
```
public Broadcaster getBroadcaster()
```
    Return the underlying Broadcaster.
    
    Returns:
  - setBroadcaster
```
public void setBroadcaster(Broadcaster b)
```
    Set a Broadcaster instance.
    
    Parameters:
    b -
  - attachement
```
public java.lang.Object attachement()
```
    Return an Object with this Meteor.
    
    Returns:
    the Object
  - attach
```
public void attach(java.lang.Object o)
```
    Attach an Object with this Meteor.
  - addListener
```
public Meteor addListener(AtmosphereResourceEventListener e)
```
    Add a AtmosphereResourceEventListener which gets invoked when responses are resuming, when the remote client closes the connection or when the a Broadcaster.broadcast(java.lang.Object) operations occurs.
    
    Parameters:
    e - an instance of AtmosphereResourceEventListener
  - removeListener
```
public Meteor removeListener(AtmosphereResourceEventListener e)
```
    Remove a AtmosphereResourceEventListener which gets invoked when a response is resuming, when the remote client closes the connection or when the a Broadcaster.broadcast(java.lang.Object) operations occurs.
    
    Parameters:
    e - an instance of AtmosphereResourceEventListener
  - destroy
```
public void destroy()
```
    Mark this instance as destroyed. No more operations will be allowed.
  - getAtmosphereResource
```
public AtmosphereResource getAtmosphereResource()
```
    Return the underlying AtmosphereResource.
    
    Returns:
    the underlying AtmosphereResource

Class Meteor

Method Summary

Methods inherited from class java.lang.Object

Method Detail

lookup

build

build

build

build

suspend

resumeOnBroadcast

transport

suspend

resume

broadcast

schedule

delayBroadadcast

getBroadcaster

setBroadcaster

attachement

attach

addListener

removeListener

destroy

getAtmosphereResource