Object

akka.wamp

Wamp

Related Doc: package wamp

Permalink

object Wamp extends ExtensionId[WampExtension] with ExtensionIdProvider

WAMP Extension for Akka’s IO layer.

For a full description of the design and philosophy behind this IO implementation please refer to the Akka online documentation.

In order to open an outbound connection send a Wamp.Connect message to the WampExtension#manager.

In order to start listening for inbound connections send a Wamp.Bind message to the WampExtension#manager.

Linear Supertypes
ExtensionIdProvider, ExtensionId[WampExtension], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Wamp
  2. ExtensionIdProvider
  3. ExtensionId
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait AbstractMessage extends AnyRef

    Permalink

    The common interface for Command and Signal.

  2. final case class Bind(router: ActorRef) extends Command with Product with Serializable

    Permalink

    The Bind message is send to the WAMP manager actor, which is obtained via WampExtension#manager in order to bind to a listening socket.

    The Bind message is send to the WAMP manager actor, which is obtained via WampExtension#manager in order to bind to a listening socket. The manager replies either with a CommandFailed or the actor handling the listen socket replies with a Bound message. If the local port is set to 0 in the Bind message, then the Bound message should be inspected to find the actual port which was bound to.

    router

    is the actor which will receive all incoming connection requests in the form of Connected messages

  3. final case class BindFailed(cause: Throwable) extends Signal with Product with Serializable

    Permalink
  4. final case class Bound(url: String) extends Signal with Product with Serializable

    Permalink

    The sender of a Bind command will — in case of success — receive confirmation in this form.

    The sender of a Bind command will — in case of success — receive confirmation in this form. If the bind address indicated a 0 port number, then the contained localAddress can be used to find out which port was automatically assigned.

  5. trait Command extends AbstractMessage

    Permalink

    This is the common trait for all commands understood by TCP actors.

  6. final case class Connect(client: ActorRef, url: String = "ws://localhost:8080/ws", subprotocol: String = "wamp.2.json") extends Command with Product with Serializable

    Permalink

    The Connect message is sent to the WAMP manager actor, which is obtained via WampExtension#manager.

    The Connect message is sent to the WAMP manager actor, which is obtained via WampExtension#manager. Either the manager replies with a CommandFailed or the actor handling the new connection replies with a Connected message.

    client

    is the client actor reference

    url

    is the URI to connect to (e.g. "ws://somehost.com:9999/path/to/ws")

    subprotocol

    is the WebSocket subprotocol to negotiate (e.g. "wamp.2.msgpack" or "wamp.2.json")

  7. final case class Connected(peer: ActorRef) extends Signal with Product with Serializable

    Permalink

    The connection actor sends this message either to the sender of a Connect command (for outbound) or to the handler for incoming connections designated in the Bind message.

  8. final case class ConnectionFailed(cause: Throwable) extends Signal with Product with Serializable

    Permalink
  9. final case class Failure(message: String) extends Signal with Product with Serializable

    Permalink
  10. trait Signal extends AbstractMessage

    Permalink

    Common interface for all signals generated by the Wammp layer actors.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Disconnect extends Command with Product with Serializable

    Permalink
  5. object Disconnected extends Signal with Product with Serializable

    Permalink
  6. object Unbind extends Product with Serializable

    Permalink

    In order to close down a listening socket, send this message to that socket’s actor (that is the actor which previously had sent the Bound message).

    In order to close down a listening socket, send this message to that socket’s actor (that is the actor which previously had sent the Bound message). The listener socket actor will reply with a Unbound message.

  7. def apply(system: ActorSystem): WampExtension

    Permalink
    Definition Classes
    ExtensionId
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def createExtension(system: ExtendedActorSystem): WampExtension

    Permalink

    Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.

    Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.

    Definition Classes
    Wamp → ExtensionId
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. final def equals(other: Any): Boolean

    Permalink
    Definition Classes
    ExtensionId → AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def get(system: ActorSystem): WampExtension

    Permalink
    Definition Classes
    ExtensionId
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def hashCode(): Int

    Permalink
    Definition Classes
    ExtensionId → AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def lookup(): ExtensionId[_ <: Extension]

    Permalink

    Returns the canonical ExtensionId for this Extension

    Returns the canonical ExtensionId for this Extension

    Definition Classes
    Wamp → ExtensionIdProvider
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExtensionIdProvider

Inherited from ExtensionId[WampExtension]

Inherited from AnyRef

Inherited from Any

Ungrouped