Class/Object

akka.wamp.client

Client

Related Docs: object Client | package client

Permalink

class Client extends Peer

WAMP clients are components which implement any or all of the subscriber, publisher, caller and callee roles. They can establish WAMP connections to a router and open new sessions.

import akka.wamp.client._
val client = Client("myapp")

import scala.concurrent.Future
implicit val ec = client.executionContext

val conn: Future[Connection] = client
  .connect(
    url = "ws://localhost:8080/ws",
    subprotocol = "wamp.2.json"
  )
Linear Supertypes
Peer, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. Peer
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. def connect(url: String = Client.defaultUrl, subprotocol: String = Client.defaultSubprotocol, maxAttempts: Int = 1): Future[Transport]

    Permalink

    Establish a WAMP connection to a router which is listening at the given URL and negotiate the given subprotocol

    Establish a WAMP connection to a router which is listening at the given URL and negotiate the given subprotocol

    url

    is the URL to connect to (default is "ws://localhost:8080/ws")

    subprotocol

    is the subprotocol to negotiate (default is "wamp.2.json")

    maxAttempts

    is the maximum number of attempts before giving up (default is 1)

    returns

    the (future of) connection or TransportException

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

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. implicit val executionContext: ExecutionContextExecutor

    Permalink

    The execution context of futures

  10. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. val log: LoggingAdapter

    Permalink

    The logger

  15. val name: String

    Permalink

    This client actor system name

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

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. def openSession(url: String = Client.defaultUrl, subprotocol: String = Client.defaultSubprotocol, realm: Uri = Hello.defaultRealm, roles: Set[Role] = Roles.client): Future[Session]

    Permalink

    Establish a WAMP connection to a router and open a new session

    Establish a WAMP connection to a router and open a new session

    url

    is the URL to connect to (default is "ws://localhost:8080/ws")

    subprotocol

    is the subprotocol to negotiate (default is "wamp.2.json")

    realm

    is the realm to attach the session to (default is "default.realm")

    roles

    is this client roles set (default is all possible client roles)

    returns

    the (future of) session or TransportException or AbortException

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

    Permalink
    Definition Classes
    AnyRef

  21. def terminate(): Future[Terminated]

    Permalink

    Terminate this client.

    Terminate this client.

    client.terminate().map { _ =>
  // ... after terminate completes ...
}
    returns

    the (future of) terminated event

  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

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

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

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

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

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

Inherited from Peer

Inherited from AnyRef

Inherited from Any

Ungrouped