org.atmosphere.annotation

Annotation Type Subscribe

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
public @interface Subscribe

Subscribe to the "value", or topic. This annotation will create a Broadcaster with the value as ID, and suspend the underlying connection. This annotation does the same as Suspend, but create the Broadcaster automatically from the value.

That annotation doesn't allow configuring the Suspend.outputComments() value. The default value is set to false. If you want to support http-streaming, make sure your client set the HeaderConfig.X_ATMOSPHERE_TRANSPORT header to "streaming".

Author:

Jeanfrancois Arcand

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value The value that will be used to create or lookup a Broadcaster

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends AtmosphereResourceEventListener>[]	listeners Add AtmosphereResourceEventListener to the broadcast operation.
int	timeout The timeout in millseconds before the connection is resumed.
boolean	writeEntity Write the returned entity back to the calling connection.

Element Detail

value

public abstract java.lang.String value

The value that will be used to create or lookup a Broadcaster

Returns:

The value that will be used to create or lookup a Broadcaster

listeners

public abstract java.lang.Class<? extends AtmosphereResourceEventListener>[] listeners

Add AtmosphereResourceEventListener to the broadcast operation.

Default:

{}

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

timeout

public abstract int timeout

The timeout in millseconds before the connection is resumed. Default is 30 seconds

Returns:

The timeout before the connection is resumed. Default is 30 seconds

Default:

30000