Messages

Type Members

1. case class Abort(details: Dict, reason: Uri) 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. trait Builder extends AnyRef

   

   Build a message instance

3. case class Error(requestType: Int, requestId: Long, details: Dict, error: Uri) 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]

4. case class Event(subscriptionId: Id, publicationId: Id, details: Dict, arguments: List[Any], argumentsKw: Option[Dict]) 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, 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.

   arguments

   is a list of application-level event payload elements. The list may be of zero length.

   argumentsKw

   is an optional dictionary containing application-level event payload, provided as keyword arguments. The dictionary may be empty.

5. case class Goodbye(details: Dict, reason: Uri) 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]

6. class GoodbyeBuilder extends Builder

   

   Build an Goodbye instance.

7. case class Hello(realm: Uri, details: Dict) 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]

8. class HelloBuilder extends Builder

   

   Build an Hello instance.

   Build an Hello instance.

   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"

9. case class Publish(requestId: Id, options: Dict, topic: Uri, arguments: List[Any], argumentsKw: Option[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, 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.

   options

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

   topic

   is the topic published to.

   arguments

   is a list of application-level event payload elements. The list may be of zero length.

   argumentsKw

   is an optional dictionary containing application-level event payload, provided as keyword arguments. The dictionary may be empty.

10. class PublishBuilder extends Builder

    

    Build an Publish instance.

11. 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]

12. case class Subscribe(requestId: Id, options: Dict, topic: Uri) 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

    options

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

    topic

    is the topic the Subscribe wants to subscribe to

13. class SubscribeBuilder extends Builder

    

    Build an Subscribe instance.

14. 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

15. 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

16. class UnsubscribeBuilder extends Builder

    

    Build an Unsubscribe instance.

17. 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

18. case class Welcome(sessionId: Long, details: Dict) extends Message with Product with Serializable

    

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

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

    [WELCOME, Session|id, Details|dict]