Package org.atmosphere.cpr

Interface PerRequestBroadcastFilter

All Superinterfaces:

BroadcastFilter

All Known Implementing Classes:

BroadcastFilterAdapter, TrackMessageSizeFilter

public interface PerRequestBroadcastFilter
extends BroadcastFilter

An extended BroadcastFilter that can be used to filter based on AtmosphereResource.

Author:

Jean-francois Arcand

Nested Class Summary

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

BroadcastFilter.BroadcastAction

Field Summary

Fields inherited from interface org.atmosphere.cpr.BroadcastFilter

VOID_ATMOSPHERE_RESOURCE_UUID

Method Summary

Modifier and Type	Method	Description
BroadcastFilter.BroadcastAction	filter(java.lang.String broadcasterId, AtmosphereResource r, java.lang.Object originalMessage, java.lang.Object message)	Transform or filter a message per AtmosphereResource.

Methods inherited from interface org.atmosphere.cpr.BroadcastFilter

filter

Method Detail

filter

BroadcastFilter.BroadcastAction filter(java.lang.String broadcasterId,
                                       AtmosphereResource r,
                                       java.lang.Object originalMessage,
                                       java.lang.Object message)

Transform or filter a message per AtmosphereResource. Be careful when setting headers on the AtmosphereResponse as the headers may have been already sent back to the browser.

Parameters:

broadcasterId - the Broadcaster.getID()

r - the AtmosphereResource

originalMessage - The original message used when calling Broadcaster.broadcast(Object)

message - a message

Returns:

a BroadcastFilter.BroadcastAction