engineio

Type Members

1. case class BinaryEngineIOMessage(bytes: ByteString) extends EngineIOMessage with Product with Serializable

   

   A binary engine.io message.

2. final class EngineIO extends AnyRef

   

   The engine.io system.

   The engine.io system. Allows you to create engine.io controllers for handling engine.io connections.

   Annotations

   @Singleton()

3. class EngineIOAkkaSerializer extends SerializerWithStringManifest with BaseSerializer

   

   Serializer for all messages sent to/from the EngineIOManagerActor.

4. trait EngineIOComponents extends AnyRef

   

   Provides engine.io components

   Provides engine.io components

   Mix this trait into your application cake to get an instance of EngineIO to build your engine.io engine with.

5. case class EngineIOConfig(pingInterval: FiniteDuration = 25.seconds, pingTimeout: FiniteDuration = 60.seconds, transports: Seq[EngineIOTransport] = ..., actorName: String = "engine.io", routerName: Option[String] = None, useRole: Option[String] = None) extends Product with Serializable

   

6. class EngineIOConfigProvider extends Provider[EngineIOConfig]

   

   Annotations

   @Singleton()

7. final class EngineIOController extends AbstractController

   

   An engine.io controller.

   An engine.io controller.

   This provides one handler, the endpoint() method. This should be routed to for all GET and POST requests for anything on the path for engine.io (for socket.io, this defaults to /socket.io/ unless configured otherwise on the client.

   The transport parameter should be extracted from the transport query parameter with the request.

   For example:

   GET     /socket.io/        play.engineio.EngineIOController.endpoint(transport)
   POST    /socket.io/        play.engineio.EngineIOController.endpoint(transport)

8. class EngineIOManagerActor extends Actor

   

   The actor responsible for managing all engine.io sessions for this node.

9. sealed trait EngineIOMessage extends AnyRef

   

   An engine.io message, either binary or text.

10. class EngineIOModule extends Module

    

    The engine.io module.

    The engine.io module.

    Provides engine.io components to Play's runtime dependency injection implementation.

11. class EngineIOSessionActor[SessionData] extends Actor with ActorLogging

    

    Actor that provides engine.io sessions.

12. trait EngineIOSessionHandler extends AnyRef

    

    A handler for engine.io sessions.

13. case class TextEngineIOMessage(text: String) extends EngineIOMessage with Product with Serializable

    

    A text engine.io message.

14. case class UnknownSessionId(sid: String) extends RuntimeException with Product with Serializable

    

    Exception thrown when a session id is unknown.

    Exception thrown when a session id is unknown.

    sid

    The unknown session id.