org.atmosphere.cpr
Interface BroadcastFilter

All Known Subinterfaces:

BroadcastFilterLifecycle, ClusterBroadcastFilter

All Known Implementing Classes:

FormParamFilter, JavascriptClientFilter, StringFilterAggregator, XSSHtmlFilter

public interface BroadcastFilter

Transform a message of type 'E" before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent)

See XSSHtmlFilter for an example.

Author:

Jeanfrancois Arcand

Nested Class Summary

static class

BroadcastFilter.BroadcastAction Simple class that tells the Broadcaster to broacast or not the transformed value.

Method Summary

BroadcastFilter.BroadcastAction

filter(Object message) Transform or Filter a message.

Method Detail

filter

BroadcastFilter.BroadcastAction filter(Object message)

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

Parameters:

message - Object a message

Returns:

a transformed message.