org.scalatra.atmosphere

AtmosphereClient

trait AtmosphereClient extends AtmosphereClientFilters

Provides a handle for a single Atmosphere connection.

Each browser or other device which connects to an atmosphere route is assigned its own AtmosphereClient, with a uuid. This is a good bet for subclassing if you need to implement your own message distribution logic. Subclasses may define their own ClientFilter logic in addition to the stock ClientFilters already defined, in order to segment message delivery.

Linear Supertypes
AtmosphereClientFilters, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AtmosphereClient
  2. AtmosphereClientFilters
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def receive: AtmoReceive

    Receive an inbound message.

Concrete Value Members

  1. final def !(msg: OutboundMessage)(implicit executionContext: ExecutionContext): Future[OutboundMessage]

    A convenience method which sends a message only to the current client, using a broadcast filter.

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  5. final def ><(msg: OutboundMessage, to: ClientFilter = Others)(implicit executionContext: ExecutionContext): Future[OutboundMessage]

    Broadcast a message to all clients, skipping the current client by default (i.e.

    Broadcast a message to all clients, skipping the current client by default (i.e. normal chat server behaviour). Optionally filter the clients to deliver the message to by applying a filter.

  6. final def Everyone: ClientFilter

    Attributes
    protected
    Definition Classes
    AtmosphereClientFilters

  7. final def Me: ClientFilter

    Attributes
    protected
    Definition Classes
    AtmosphereClientFilters

  8. final def OnlySelf: ClientFilter

    Deliver the message only to the current user.

    Deliver the message only to the current user.

    Attributes
    protected
    Definition Classes
    AtmosphereClientFilters

  9. final def Others: ClientFilter

    Attributes
    protected
    Definition Classes
    AtmosphereClientFilters

  10. final def SkipSelf: ClientFilter

    Deliver the message to everyone except the current user.

    Deliver the message to everyone except the current user.

    Attributes
    protected
    Definition Classes
    AtmosphereClientFilters

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. final def broadcast(msg: OutboundMessage, to: ClientFilter = Others)(implicit executionContext: ExecutionContext): Future[OutboundMessage]

    Broadcast a message to all clients, skipping the current client by default (i.e.

    Broadcast a message to all clients, skipping the current client by default (i.e. normal chat server behaviour). Optionally filter the clients to deliver the message to by applying a filter.

  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  23. def requestUri: String

    Attributes
    protected

  24. final def send(msg: OutboundMessage)(implicit executionContext: ExecutionContext): Future[OutboundMessage]

    A convenience method which sends a message only to the current client, using a broadcast filter.

    A convenience method which sends a message only to the current client, using a broadcast filter. This is the same as calling broadcast(message, to = Me)

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  26. def toString(): String

    Definition Classes
    AnyRef → Any

  27. final def uuid: String

    A unique identifier for a given connection.

    A unique identifier for a given connection. Can be used for filtering purposes.

    Definition Classes
    AtmosphereClient → AtmosphereClientFilters

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AtmosphereClientFilters

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped