org.atmosphere.annotation
Annotation Type Broadcast

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface Broadcast

Broadcast to all suspended response the value of the method annotated with this annotation.

Author:

Jeanfrancois Arcand

Optional Element Summary

int	delay Should the broadcast be delayed? A value of 0 means the broadcast be delayed until a normal broadcast operation happens.
boolean	resumeOnBroadcast Resume all suspended response on the first broadcast operation.
Class<? extends BroadcastFilter>[]	value Add BroadcastFilter to the broadcast operation.
boolean	writeEntity Write the returned entity back to the calling connection.

value

public abstract Class<? extends BroadcastFilter>[] value

Add BroadcastFilter to the broadcast operation.

Default:

{}

resumeOnBroadcast

public abstract boolean resumeOnBroadcast

Resume all suspended response on the first broadcast operation.

Default:

false

delay

public abstract int delay

Should the broadcast be delayed? A value of 0 means the broadcast be delayed until a normal broadcast operation happens. Any other value will be evaluated as seconds

Default:

-1

writeEntity

public abstract boolean writeEntity

Write the returned entity back to the calling connection. Default is false.

Returns:

true if the entity needs to be written back to the calling connection.

Default:

true