messages

Type Members

1. final case class Abort(reason: Uri, details: Dict = Abort.DefaultDetails) extends Message with Product with Serializable

   

   Sent by a Peer to abort the opening of a Session.

   Sent by a Peer to abort the opening of a Session. No response is expected.

   [ABORT, Details|dict, Reason|uri]

2. final case class Error(requestType: Int, requestId: Id, details: Dict, error: Uri, payload: Option[Payload] = None) extends Message with Product with Serializable

   

   Error reply sent by a Peer as an error response to different kinds of requests.

   Error reply sent by a Peer as an error response to different kinds of requests.

   [ERROR, REQUEST.Type|int, REQUEST.Request|id, Details|dict, Error|uri [ERROR, REQUEST.Type|int, REQUEST.Request|id, Details|dict, Error|uri, Arguments|list] [ERROR, REQUEST.Type|int, REQUEST.Request|id, Details|dict, Error|uri, Arguments|list, ArgumentsKw|dict]

   payload

   is either a list of any arguments or a key-value-pairs set

3. final case class Event(subscriptionId: Id, publicationId: Id, details: Dict, payload: Option[Payload] = None) extends Message with Product with Serializable

   

   Event dispatched by Broker to Subscribers for Subscriptions the event was matching.

   Event dispatched by Broker to Subscribers for Subscriptions the event was matching.

   [EVENT, SUBSCRIBED.Subscription|id, PUBLISHED.Publication|id, Details|dict] [EVENT, SUBSCRIBED.Subscription|id, PUBLISHED.Publication|id, Details|dict, Arguments|list] [EVENT, SUBSCRIBED.Subscription|id, PUBLISHED.Publication|id, Details|dict, Arguments|list, ArgumentsKw|dict]

   subscriptionId

   is the ID for the subscription under which the Subscribe receives the event (the ID for the subscription originally handed out by the Broker to the Subscriber.

   publicationId

   is the ID of the publication of the published event

   details

   is a dictionary that allows to provide additional event details in an extensible way.

   payload

   is either a list of any arguments or a key-value-pairs set

4. final case class Goodbye(reason: Uri = Goodbye.DefaultReason, details: Dict = Goodbye.DefaultDetails) extends Message with Product with Serializable

   

   Sent by a Peer to close a previously opened Session.

   Sent by a Peer to close a previously opened Session. Must be echo'ed by the receiving Peer.

   [GOODBYE, Details|dict, Reason|uri]

5. final case class Hello(realm: Uri = "akka.wamp.realm", details: Dict = Hello.DefaultDetails) extends Message with Product with Serializable

   

   Sent by a Client to initiate opening of a Session to a Router attaching to a Realm.

   Sent by a Client to initiate opening of a Session to a Router attaching to a Realm.

   [HELLO, Realm|uri, Details|dict]

   WAMP uses "roles & features announcement" instead of "protocol versioning" to allow

   - implementations only supporting subsets of functionality - future extensibility

   A Client must announce the roles it supports via "Hello.Details.roles|dict", with a key mapping to a "Hello.Details.roles.<role>|dict" where "<role>" can be:

   - "publisher" - "subscriber" - "caller" - "callee"

6. sealed trait Message extends AbstractMessage

   

   Common interface of WAMP messages exchanged by two Peers during a Session

7. final case class Publish(requestId: Id, topic: Uri, payload: Option[Payload] = None, options: Dict = Dict()) extends Message with Product with Serializable

   

   Sent by a Publisher to a Broker to publish an Event.

   Sent by a Publisher to a Broker to publish an Event.

   [PUBLISH, Request|id, Options|dict, Topic|uri] [PUBLISH, Request|id, Options|dict, Topic|uri, Arguments|list] [PUBLISH, Request|id, Options|dict, Topic|uri, Arguments|list, ArgumentsKw|dict]

   requestId

   is a random, ephemeral ID chosen by the Publisher and used to correlate the Broker's response with the request.

   topic

   is the topic published to.

   payload

   is either a list of any arguments or a key-value-pairs set

   options

   is a dictionary that allows to provide additional publication request details in an extensible way.

8. final case class Published(requestId: Id, publicationId: Id) extends Message with Product with Serializable

   

   Acknowledge sent by a Broker to a Publisher for acknowledged Publications.

   Acknowledge sent by a Broker to a Publisher for acknowledged Publications.

   [PUBLISHED, PUBLISH.Request|id, Publication|id]

9. final case class Subscribe(requestId: Id, topic: Uri, options: Dict = Subscribe.DefaultOptions) extends Message with Product with Serializable

   

   Subscribe request sent by a Subscriber to a Broker to subscribe to a Topic.

   Subscribe request sent by a Subscriber to a Broker to subscribe to a Topic.

   [SUBSCRIBE, Request|id, Options|dict, Topic|uri]

   requestId

   is a random, ephemeral ID chosen by the Subscribe and used to correlate the Broker's response with the request

   topic

   is the topic the Subscribe wants to subscribe to

   options

   is a dictionary that allows to provide additional subscription request details in a extensible way

10. final case class Subscribed(requestId: Id, subscriptionId: Id) extends Message with Product with Serializable

    

    Acknowledge sent by a Broker to a Subscriber to acknowledge a subscription.

    Acknowledge sent by a Broker to a Subscriber to acknowledge a subscription.

    [SUBSCRIBED, SUBSCRIBE.Request|id, Subscription|id]

    requestId

    is the ID from the original Subscribe request

    subscriptionId

    is an ID chosen by the Broker for the subscription

11. final case class Unsubscribe(requestId: Id, subscriptionId: Id) extends Message with Product with Serializable

    

    Unsubscribe request sent by a Subscriber to a Broker to unsubscribe from a Subscription.

    Unsubscribe request sent by a Subscriber to a Broker to unsubscribe from a Subscription. [UNSUBSCRIBE, Request|id, SUBSCRIBED.Subscription|id]

    requestId

    is a random, ephemeral ID chosen by the Unsubscribe and used to correlate the Broker's response with the request

    subscriptionId

    is the ID for the subscription to unsubscribe from, originally handed out by the Broker to the Subscriber

12. final case class Unsubscribed(requestId: Id) extends Message with Product with Serializable

    

    Acknowledge sent by a Broker to a Subscriber to acknowledge unsubscription.

    Acknowledge sent by a Broker to a Subscriber to acknowledge unsubscription.

    [UNSUBSCRIBED, UNSUBSCRIBE.Request|id]

    requestId

    is the ID from the original Subscribed request

13. final case class Welcome(sessionId: Id, details: Dict = Welcome.DefaultDetails) extends Message with Product with Serializable

    

    Sent by a Router to accept a Client and let it know the Session is now open

    Sent by a Router to accept a Client and let it know the Session is now open

    [WELCOME, Session|id, Details|dict]

    sessionId

    is the session identifier

    details

    is the session details