org.atmosphere.annotation

Annotation Type Suspend

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

Suspend the underlying response. Once suspended, a response might be allowed to consume Broadcast events, depending on the scope ([@link Suspend#SCOPE}). By default, a suspended response is suspended able to consume any broadcasted events executed inside the same application (SCOPE.APPLICATION). The period can also be per suspended response (SCOPE.REQUEST) or available to other application (SCOPE.VM).

Author:

Jeanfrancois Arcand

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	contentType If the @Produces annotation is missing, this value will be used instead.
java.lang.Class<? extends AtmosphereResourceEventListener>[]	listeners Add AtmosphereResourceEventListener to the broadcast operation.
boolean	outputComments By default, output some comments when suspending the connection.
int	period How long a response stay suspended in timeUnit(), default is -1
boolean	resumeOnBroadcast Resume all suspended response on the first broadcast operation.
Suspend.SCOPE	scope The Scope of the Broadcaster that will be created once the response gets suspended.
java.util.concurrent.TimeUnit	timeUnit
boolean	writeEntity Write the returned entity back to the calling connection.

Element Detail

period

public abstract int period

How long a response stay suspended in timeUnit(), default is -1

Returns:

Default:

-1

timeUnit

public abstract java.util.concurrent.TimeUnit timeUnit

Returns:

Default:

java.util.concurrent.TimeUnit.MILLISECONDS

scope

public abstract Suspend.SCOPE scope

The Scope of the Broadcaster that will be created once the response gets suspended. One final word on Broadcaster: by default, a Broadcaster will broadcast using all resources/classes on which the response has been suspended. This behavior is configurable and you can configure it setting the appropriate scope

• REQUEST: broadcast events only to the suspended response associated with the current request.
• APPLICATION: broadcast events to all suspended responses associated with the current application.
• VM: broadcast events to all suspended responses created inside the current virtual machine.

Returns:

The Scope of the Broadcaster that will be created once the response gets suspended.

Default:

org.atmosphere.annotation.Suspend.SCOPE.APPLICATION

outputComments

public abstract boolean outputComments

By default, output some comments when suspending the connection.

Default:

true

resumeOnBroadcast

public abstract boolean resumeOnBroadcast

Resume all suspended response on the first broadcast operation.

Default:

false

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

contentType

public abstract java.lang.String contentType

If the @Produces annotation is missing, this value will be used instead.

Returns:

the default content-type used if the @Produces annotation is missing.

Default:

""