org.atmosphere.client
Class JavascriptClientFilter

java.lang.Object
  org.atmosphere.client.JavascriptClientFilter

All Implemented Interfaces:

BroadcastFilter

public class JavascriptClientFilter
extends Object
implements BroadcastFilter

Filter that inject Javascript code to a broadcast so it can be used with the Atmosphere JQuery Plugin.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.cpr.BroadcastFilter

BroadcastFilter.BroadcastAction

Constructor Summary

JavascriptClientFilter()

Method Summary

BroadcastFilter.BroadcastAction

filter(Object message) Transform or Filter a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavascriptClientFilter

public JavascriptClientFilter()

Method Detail

filter

public BroadcastFilter.BroadcastAction filter(Object message)

Description copied from interface: BroadcastFilter

Transform or Filter a message. Return null to tell the associated Broadcaster to discard the message, e.g to not broadcast it.

Specified by:

filter in interface BroadcastFilter

Parameters:

message - Object a message

Returns:

a transformed message.