Trait/Object

com.lightbend.lagom.scaladsl.api.broker

Message

Related Docs: object Message | package broker

Permalink

sealed trait Message[Payload] extends AnyRef

A message broker message.

This provides access to both the message payload, and the metadata.

Source
MessageMetadata.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Message
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def +[Metadata](keyValue: (MetadataKey[Metadata], Metadata)): Message[Payload]

    Permalink

    Add a metadata key and value to this message.

    Add a metadata key and value to this message.

    keyValue

    The key and value to add.

    returns

    A copy of this message with the key and value added.

  2. abstract def get[Metadata](key: MetadataKey[Metadata]): Option[Metadata]

    Permalink

    Get the metadata for the given metadata key.

    Get the metadata for the given metadata key.

    key

    The key of the metadata.

    returns

    The metadata, if found for that key.

  3. abstract def payload: Payload

    Permalink

    The payload of the message.

  4. abstract def withPayload[P2](payload: P2): Message[P2]

    Permalink

    Return a copy of this message with the given payload.

    Return a copy of this message with the given payload.

    payload

    The payload.

    returns

    A copy of this message with the given payload.

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Message[Payload], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Message[Payload] to ArrowAssoc[Message[Payload]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def ensuring(cond: (Message[Payload]) ⇒ Boolean, msg: ⇒ Any): Message[Payload]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Message[Payload] to Ensuring[Message[Payload]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (Message[Payload]) ⇒ Boolean): Message[Payload]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Message[Payload] to Ensuring[Message[Payload]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: ⇒ Any): Message[Payload]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Message[Payload] to Ensuring[Message[Payload]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): Message[Payload]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Message[Payload] to Ensuring[Message[Payload]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Message[Payload] to StringFormat[Message[Payload]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  18. def messageKeyAsString: String

    Permalink

    Get the message key as a String.

    Get the message key as a String.

    If the key is not a String, it will be converted to a String using toString.

    If the underlying message broker doesn't support keys, the empty string will be returned.

    returns

    A string representation of the message key.

  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( ... )
  27. def [B](y: B): (Message[Payload], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Message[Payload] to ArrowAssoc[Message[Payload]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Message[Payload] to any2stringadd[Message[Payload]] performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (message: any2stringadd[Message[Payload]]).+(other)
    Definition Classes
    any2stringadd

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Message[Payload] to any2stringadd[Message[Payload]]

Inherited by implicit conversion StringFormat from Message[Payload] to StringFormat[Message[Payload]]

Inherited by implicit conversion Ensuring from Message[Payload] to Ensuring[Message[Payload]]

Inherited by implicit conversion ArrowAssoc from Message[Payload] to ArrowAssoc[Message[Payload]]

Ungrouped