Packages

final class MqttMessageProperties extends AnyRef

A representation of the packet-level properties sent/received with a message from MQTT.

Only properties which appear in the PUBLISH packet (see MQTTv5 specification) are exposed. The Paho client handles topic aliases, so those properties are not exposed.

The 'sourceProperties' (including the subscription identifiers) are cleared on any update. Consumers who will use such properties are advised to capture the source properties at the earliest opportunity after receipt.

Constructor is INTERNAL API

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MqttMessageProperties
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asNewProperties: MqttProperties
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val contentType: Option[String]
  8. val correlationData: Option[Array[Byte]]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(other: Any): Boolean

    'sourceProperties' and 'correlationData' are not considered for equality.

    'sourceProperties' and 'correlationData' are not considered for equality. Additionally, properties that may be semantically equivalent (e.g. leaving 'payloadFormat' undefined vs. defining it to be false) could test non-equal, as this comparison does not take defaults into account.

    Definition Classes
    MqttMessageProperties → AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getContentType: Optional[String]

    Java API

  13. def getCorrelationData: Optional[Array[Byte]]

    Java API

  14. def getMessageExpiryIntervalDuration: Optional[Duration]

    Java API

  15. def getMessageExpiryIntervalSeconds: Optional[Long]

    Java API

  16. def getPayloadFormat: Optional[Boolean]

    Java API

  17. def getResponseTopic: Optional[String]

    Java API

  18. def getSourceProperties: Optional[MqttProperties]

    Java API

  19. def getSubscriptionIdentifiers: List[Integer]

    Java API.

    Java API. Will only be available with messages received from MQTT.

  20. def getUserProperties: List[UserProperty]

    Java API

  21. def hasCorrelationData: Boolean
  22. def hasMessageExpiryInterval: Boolean
  23. def hasPayloadFormat: Boolean
  24. def hasResponseTopic: Boolean
  25. def hashCode(): Int
    Definition Classes
    MqttMessageProperties → AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def isPayloadFormatUnspecifiedBytes: Boolean
  28. def isPayloadFormatUtf8: Boolean
  29. val messageExpiryInterval: Option[Long]
  30. def messageExpiryIntervalDuration: Option[FiniteDuration]

    Scala API

  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. val payloadFormat: Option[Boolean]
  35. val responseTopic: Option[String]
  36. val sourceProperties: Option[MqttProperties]
  37. def subscriptionIdentifiers: Seq[Int]

    Scala API.

    Scala API. Will only be available with messages received from MQTT.

  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    MqttMessageProperties → AnyRef → Any
  40. val userProperties: Seq[UserProperty]
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  44. def withAddedUserProperties(properties: List[UserProperty]): MqttMessageProperties

    Java API

  45. def withAddedUserProperties(properties: Seq[UserProperty]): MqttMessageProperties

    Scala API

  46. def withAddedUserProperty(property: UserProperty): MqttMessageProperties
  47. def withContentType(contentType: String): MqttMessageProperties
  48. def withCorrelationData(bytes: Array[Byte]): MqttMessageProperties
  49. def withMessageExpiryInterval(interval: Duration): MqttMessageProperties

    Java API

  50. def withMessageExpiryInterval(interval: FiniteDuration): MqttMessageProperties

    Scala API

  51. def withMessageExpiryInterval(seconds: Long): MqttMessageProperties
  52. def withPayloadFormat(isUtf8: Boolean): MqttMessageProperties
  53. def withPayloadUnspecifiedBytes: MqttMessageProperties
  54. def withPayloadUtf8: MqttMessageProperties
  55. def withResponseTopic(topic: String): MqttMessageProperties
  56. def withUserProperties(properties: List[UserProperty]): MqttMessageProperties

    Java API

  57. def withUserProperties(properties: Seq[UserProperty]): MqttMessageProperties

    Scala API

  58. def withoutContentType: MqttMessageProperties
  59. def withoutCorrelationData: MqttMessageProperties
  60. def withoutMessageExpiryInterval: MqttMessageProperties
  61. def withoutPayloadFormat: MqttMessageProperties
  62. def withoutResponseTopic: MqttMessageProperties
  63. def withoutUserProperties: MqttMessageProperties

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped