org.atmosphere.jersey

Class Broadcastable

java.lang.Object

org.atmosphere.jersey.Broadcastable

public class Broadcastable
extends java.lang.Object

Simple placeholder that can be used to broadcast message using a specific Broadcaster.

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Constructor and Description
Broadcastable(Broadcaster b)
Broadcastable(java.lang.Object message, Broadcaster b) Broadcast the message to the set of suspended AtmosphereResource, and write back the message to the request which invoked the current resource method.
Broadcastable(java.lang.Object message, java.lang.Object callerMessage, Broadcaster b) Broadcast the message to the set of suspended AtmosphereResource, and write back the callerMessage to the request which invoked the current resource method.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	broadcast() Broadcast the message.
Broadcaster	getBroadcaster()
java.lang.Object	getMessage()
java.lang.Object	getResponseMessage()

Methods inherited from class java.lang.Object

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

Constructor Detail

Broadcastable

public Broadcastable(Broadcaster b)

Broadcastable

public Broadcastable(java.lang.Object message,
                     Broadcaster b)

Broadcast the message to the set of suspended AtmosphereResource, and write back the message to the request which invoked the current resource method.

Parameters:

message - the message which will be broadcasted

b - the Broadcaster

Broadcastable

public Broadcastable(java.lang.Object message,
                     java.lang.Object callerMessage,
                     Broadcaster b)

Broadcast the message to the set of suspended AtmosphereResource, and write back the callerMessage to the request which invoked the current resource method.

Parameters:

message - the message which will be broadcasted

callerMessage - the message which will be sent back to the request.

b - the Broadcaster

Method Detail

broadcast

public java.lang.Object broadcast()

Broadcast the message.

Returns:

the transformed message (BroadcastFilter)

getMessage

public java.lang.Object getMessage()

getBroadcaster

public Broadcaster getBroadcaster()

getResponseMessage

public java.lang.Object getResponseMessage()