Package org.atmosphere.annotation

Annotation Interface Broadcast

@Target(METHOD) @Retention(RUNTIME) public @interface Broadcast
Broadcast to all suspended response the value of the method annotated with this annotation.
Author:
Jeanfrancois Arcand

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    delay
    Should the broadcast be delayed? A value of 0 means the broadcast be delayed until a normal broadcast operation happens.
    Class<? extends org.atmosphere.cpr.BroadcastFilter>[]
    filters
    Add BroadcastFilters to the broadcast operation.
    boolean
    resumeOnBroadcast
    Resume all suspended response on the first broadcast operation.
    String
    value
     
    boolean
    writeEntity
    Write the returned entity back to the calling connection.

  • Element Details

    • value

      String value
      Default:
      "/*"

    • filters

      Class<? extends org.atmosphere.cpr.BroadcastFilter>[] filters
      Add BroadcastFilters to the broadcast operation.
      Default:
      {}

    • resumeOnBroadcast

      boolean resumeOnBroadcast
      Resume all suspended response on the first broadcast operation.
      Default:
      false

    • delay

      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

      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