Packages

final case class Publish(requestId: Id, options: Dict = Publish.defaultOptions, topic: Uri, payload: Payload = Payload())(implicit validator: Validator) extends ProtocolMessage with DataConveyor with Product with Serializable

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

payload

is the payload bearing application data

Linear Supertypes
Serializable, Serializable, Product, Equals, DataConveyor, ProtocolMessage, Message, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Publish
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DataConveyor
  7. ProtocolMessage
  8. Message
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Publish(requestId: Id, options: Dict = Publish.defaultOptions, topic: Uri, payload: Payload = Payload())(implicit validator: Validator)

    requestId

    is a random, ephemeral identifier 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.

    payload

    is the payload bearing application data

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def args: Future[List[Any]]

    Is the conveyed data as list of indexed arguments

    Is the conveyed data as list of indexed arguments

    returns

    the (future of) indexed args

    Definition Classes
    DataConveyor
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def kwargs[T](implicit ctag: ClassTag[T]): Future[T]

    Is the conveyed data as instance of the given user tpye

    Is the conveyed data as instance of the given user tpye

    T

    is the user type

    returns

    the (future of) named args

    Definition Classes
    DataConveyor
  12. def kwargs: Future[Map[String, Any]]

    Is the conveyed data as dictionary of named arguments

    Is the conveyed data as dictionary of named arguments

    returns

    the (future of) named args

    Definition Classes
    DataConveyor
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. val options: Dict
  17. val payload: Payload
    Definition Classes
    PublishDataConveyor
  18. val requestId: Id
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. val topic: Uri
  21. val tpe: Int
    Definition Classes
    PublishProtocolMessage
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DataConveyor

Inherited from ProtocolMessage

Inherited from Message

Inherited from AnyRef

Inherited from Any

Ungrouped