org.atmosphere.handler

Class AtmosphereHandlerAdapter

java.lang.Object

org.atmosphere.handler.AtmosphereHandlerAdapter

All Implemented Interfaces:

AtmosphereHandler

public class AtmosphereHandlerAdapter
extends java.lang.Object
implements AtmosphereHandler

An implementation of AtmosphereHandler that does nothing.

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Constructor and Description
AtmosphereHandlerAdapter()

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy this handler
void	onRequest(AtmosphereResource resource) When a client sends a request to its associated AtmosphereHandler, it can decide if the underlying connection can be suspended (creating a Continuation) or handle the connection synchronously.
void	onStateChange(AtmosphereResourceEvent event) This method is invoked when the Broadcaster executes a broadcast operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AtmosphereHandlerAdapter

public AtmosphereHandlerAdapter()

Method Detail

onRequest

public void onRequest(AtmosphereResource resource)
               throws java.io.IOException

Description copied from interface: AtmosphereHandler

When a client sends a request to its associated AtmosphereHandler, it can decide if the underlying connection can be suspended (creating a Continuation) or handle the connection synchronously.

It is recommended to only suspend requests for which HTTP method is a GET and use the POST method to send data to the server, without marking the connection as asynchronous.

Specified by:

onRequest in interface AtmosphereHandler

Parameters:

resource - an AtmosphereResource

Throws:

java.io.IOException

onStateChange

public void onStateChange(AtmosphereResourceEvent event)
                   throws java.io.IOException

Description copied from interface: AtmosphereHandler

This method is invoked when the Broadcaster executes a broadcast operation. When this method is invoked its associated Broadcaster, any suspended connection will be allowed to write the data back to its associated clients.

This method will also be invoked when a response get resumed, e.g. when AtmosphereResource.resume() gets invoked. In that case, AtmosphereResourceEvent.isResuming() will return true.

This method will also be invoked when the AtmosphereResource.suspend(long) expires. In that case, AtmosphereResourceEvent.isResumedOnTimeout() will return true.

Specified by:

onStateChange in interface AtmosphereHandler

Parameters:

event - an AtmosphereResourceEvent

Throws:

java.io.IOException

destroy

public void destroy()

Description copied from interface: AtmosphereHandler

Destroy this handler

Specified by:

destroy in interface AtmosphereHandler