MQTT 3.1.1 and 5.0 transport binding #158

clemensv · 2018-04-12T15:42:19Z

Proposed MQTT 3.1.1 and 5.0 transport binding, analogous to the same for HTTP and AMQP. This includes the same JSON mapping as the HTTP PR for completeness and the JSON mapping should be discussed there, since HTTP has higher priority.

Signed-off-by: Clemens Vasters clemensv@microsoft.com

lfourie · 2018-04-19T15:58:03Z

Change http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1html
http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html

lfourie · 2018-04-19T16:08:57Z

Change http://docs.oasis-open.org/mqtt/mqtt/5.0.0/mqtt-5.0.0.html
to http://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html

lfourie · 2018-04-20T15:51:36Z

mqtt-transport-binding.md

+For instance, if the declared `contentType` is
+`application/json;charset=utf-8`, the expectation is that the `data` attribute
+value is made available as [UTF-8][RFC3629] encoded JSON text for use in
+AMQP.


Change AMQP to MQTT

lfourie · 2018-04-20T15:55:18Z

mqtt-transport-binding.md

+## 3. MQTT PUBLISH Message Mapping
+
+With MQTT 5.0, the content mode is chosen by the sender of the event. Gestures
+that might allow solicitation of events using a particular mode might be


"Gestures .... " is unclear - reword sentence.

"Protocol usage patterns"

lfourie · 2018-04-20T15:57:24Z

mqtt-transport-binding.md

+that might allow solicitation of events using a particular mode might be
+defined by an application, but are not defined here.
+
+The receiver of the event can distinguish between the two modes by inspecting


change to "two content modes"

lfourie · 2018-04-20T15:59:17Z

mqtt-transport-binding.md

+defined by an application, but are not defined here.
+
+The receiver of the event can distinguish between the two modes by inspecting
+the `content-type` message field. If the value is prefixed with the Cloud


Replace "value" with "value of the Content Type property"

lfourie · 2018-04-20T16:01:33Z

mqtt-transport-binding.md

+[event format](#14-event-formats), the receiver uses *structured* mode,
+otherwise it defaults to *binary* mode.
+
+If a receiver detects the Cloud Events media type, but with an event format that


Can you clarify how the receiver "detects the Cloud Event media type".

"If a receiver finds a CloudEvents media type as per the above rule"

lfourie · 2018-04-20T17:23:50Z

mqtt-transport-binding.md

+The *binary* content mode accommodates any shape of event data, and allows for
+efficient transfer and without transcoding effort.
+
+#### 3.1.1 MQTT PUBLISH content-type


MQTT PUBLISH Content Type (normative name)

lfourie · 2018-04-20T17:27:29Z

mqtt-transport-binding.md

+defined by an application, but are not defined here.
+
+The receiver of the event can distinguish between the two modes by inspecting
+the `content-type` message field. If the value is prefixed with the Cloud


Replace " the 'content-type' message field" with "the Content Type property of the MQTT PUBLISH message"

lfourie · 2018-04-20T17:37:18Z

mqtt-transport-binding.md

+
+#### 3.1.1 MQTT PUBLISH content-type
+
+For the *binary* mode, the MQTT PUBLISH message's [`content-type`][5-content-type]


Replace "content-type field value" with "MQTT Content Type property"

"the MQTT PUBLISH message's [Content Type][5-content-type] property"

lfourie · 2018-04-20T17:39:55Z

mqtt-transport-binding.md

+hops, and across multiple transports. This is the only supported mode for 
+MQTT 3.1.1
+
+#### 3.2.1. MQTT Content-Type


"Content Type" not "Content-Type"

lfourie · 2018-04-20T17:40:23Z

mqtt-transport-binding.md

+
+#### 3.2.1. MQTT Content-Type
+
+For MQTT 5.0, the [MQTT `content-type`][5-content-type] field is set to the media


Content Type property

lfourie · 2018-04-20T17:49:54Z

mqtt-transport-binding.md

+#### 3.1.3. Metadata Headers
+
+All [Cloud Events][CE] attributes with exception of `contentType` and `data`
+are individually mapped to and from the MQTT PUBLISH User Property section.


change to: ... from one or more User Property fields in the MQTT PUBLISH message.

I am making this slightly stronger: "MUST be individually mapped to and from the User Property fields in the MQTT PUBLISH message."

lfourie · 2018-04-20T17:51:37Z

mqtt-transport-binding.md

+
+##### 3.1.3.1 User Property Names
+
+Cloud Event attribute names are used unchanged in the MQTT PUBLISH User Property


change to "in each User Property in the MQTT PUBLISH message.

Again, stronger: "Cloud Event attribute names MUST be used unchanged in each mapped User Property
in the MQTT PUBLISH message."

lfourie · 2018-04-20T17:52:07Z

mqtt-transport-binding.md

+
+##### 3.1.3.2 User Property Values
+
+The value for each MQTT PUBLISH user property is constructed from the respective


User Property

lfourie · 2018-04-20T18:18:14Z

mqtt-transport-binding.md

+``` text
+------------------ PUBLISH -------------------
+
+topic: mytopic


topic: -> Topic Name:

lfourie · 2018-04-20T18:19:35Z

mqtt-transport-binding.md

+------------------ PUBLISH -------------------
+
+topic: mytopic
+content-type: application/json; charset=utf-8


content-type: -> Content Type:

lfourie · 2018-04-20T18:20:24Z

mqtt-transport-binding.md

+
+#### 3.2.3. Metadata Headers
+
+For MQTT 5.0, implementations MAY include the same MQTT PUBLISH user properties


User Properties

lfourie · 2018-04-20T18:20:54Z

mqtt-transport-binding.md

+``` text
+------------------ PUBLISH -------------------
+
+topic: mytopic


topic: -> Topic Name:

lfourie · 2018-04-20T18:22:37Z

mqtt-transport-binding.md

+------------------ PUBLISH -------------------
+
+topic: mytopic
+content-type: application/json; charset=utf-8


content-type: -> Content Type:

lfourie · 2018-04-20T18:25:35Z

mqtt-transport-binding.md

+[CE]: ./spec.md
+[JSON-format]: ./json-format.md
+[OASIS-MQTT-3.1.1]: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1html
+[OASIS-MQTT-5]: http://docs.oasis-open.org/mqtt/mqtt/5.0.0/mqtt-5.0.0.html


http://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html

lfourie · 2018-04-23T16:11:44Z

mqtt-transport-binding.md

+[RFC2046]: https://tools.ietf.org/html/rfc2046
+[RFC2119]: https://tools.ietf.org/html/rfc2119
+[RFC3629]: https://tools.ietf.org/html/rfc3629
+[RFC4627]: https://tools.ietf.org/html/rfc4627


Add: [RFC7159] https://tools.ietf.org/html/rfc7159

lfourie · 2018-04-23T16:15:29Z

mqtt-transport-binding.md

+[CloudEvents][CE] is a standardized and transport-neutral definition of the
+structure and metadata description of events. This specification defines how
+the elements defined in the CloudEvents specification are to be used in
+MQTT PUBLISH ([3.1.1][3-publish], [5.0][5-publish]) messages.


lfourie · 2018-04-23T16:15:40Z

mqtt-transport-binding.md

+
+This specification does not prescribe rules constraining transfer or
+settlement of event messages with MQTT; it solely defines how CloudEvents
+are expressed as MQTT PUBLISH messages ([3.1.1][3-publish], [5.0][5-publish]).


lfourie · 2018-04-23T16:21:02Z

mqtt-transport-binding.md

+
+#### 3.2.1. MQTT Content Type
+
+For MQTT 5.0, the [MQTT PUBLISH message's `Content Type`][5-content-type]


Change [MQTT ..... to MQTT..... [`Content

jwende · 2018-04-27T13:57:16Z

Not sure if this is by intention but within the documents there are different notations for content type:
application/json;charset=utf-8
application/jcloudevents+json;charset=utf-8
application/cloudevents+json; charset=UTF-8

jwende · 2018-04-27T13:59:06Z

3.1.4 Examples - I would suggest to use a mapping table between MQTT V5 PUBLISH message fields and the content of the cloud event

jwende · 2018-04-27T14:00:19Z

3.2.4 Examples - I would prefer two examples - one for MQTT 3.1.1 and one for MQTT 5.0

jwende · 2018-04-27T14:01:59Z

3.2.3. Metadata Headers - I would vote for SHOULD instead of MAY - to keep it as close as possible to the binary content mode

clemensv · 2018-05-16T10:01:18Z

@jwende I've addressed your comments in an update, mostly with clarifications. Exception: I left "MAY" stand for the moment, mostly because I've got "MAY" in all bindings and if we change that I want to make it one change and I want the group to agree to us duplicating the metadata.

jwende · 2018-05-16T10:12:01Z

@clemensv thanks. Will take a look later today.

yaronha · 2018-05-24T17:33:14Z

@clemensv following the call, would be good to have the same attribute names (in binary mode) for all transport, seems like HTTP and MQTT attr names dont match, i would like to avoid attribute+transport specific consumer logic

duglin · 2018-05-24T18:06:08Z

@clemensv provided an overview during today's call. Unless there are an objections, the plan is to see if we can merge this during next week's call and then deal with any issues/questions in follow-on PRs. So please review this PR before next week's call.

Signed-off-by: Clemens Vasters <clemensv@microsoft.com>

duglin · 2018-05-31T15:36:48Z

@clemensv I rebased (and fixed the conflict in Makefile) for you - hope that's ok.

duglin · 2018-06-01T01:23:43Z

Approved on the 5/31 call

duglin · 2018-06-01T01:24:20Z

Note - if there are any follow-on changes people want to make, please open up a PR with the suggested wording you'd like to see.

clemensv mentioned this pull request Apr 17, 2018

Temporarily cut some attributes for 0.1? #163

Closed

lfourie reviewed Apr 20, 2018

View reviewed changes

lfourie reviewed Apr 23, 2018

View reviewed changes

duglin added not-required-for-v1.0 v1.0 and removed not-required-for-v1.0 labels May 10, 2018

clemensv force-pushed the mqttBinding branch from 931d4c6 to 8eaac9d Compare May 16, 2018 10:41

This was referenced May 24, 2018

NATS transport binding (old) #214

Closed

NATS transport binding #215

Merged

MQTT proposal, rebase

29fd760

Signed-off-by: Clemens Vasters <clemensv@microsoft.com>

duglin force-pushed the mqttBinding branch from 8eaac9d to 29fd760 Compare May 31, 2018 15:35

duglin merged commit 3278e88 into cloudevents:master Jun 1, 2018

longit644 mentioned this pull request Sep 1, 2018

Kafka transport binding #300

Closed

duglin mentioned this pull request Nov 30, 2018

v0.2 #358

Merged


		#### 3.1.1 MQTT PUBLISH content-type

		For the binary mode, the MQTT PUBLISH message's [`content-type`][5-content-type]


		#### 3.2.1. MQTT Content-Type

		For MQTT 5.0, the [MQTT `content-type`][5-content-type] field is set to the media


		##### 3.1.3.1 User Property Names

		Cloud Event attribute names are used unchanged in the MQTT PUBLISH User Property


		##### 3.1.3.2 User Property Values

		The value for each MQTT PUBLISH user property is constructed from the respective


		#### 3.2.3. Metadata Headers

		For MQTT 5.0, implementations MAY include the same MQTT PUBLISH user properties


		#### 3.2.1. MQTT Content Type

		For MQTT 5.0, the [MQTT PUBLISH message's `Content Type`][5-content-type]

MQTT 3.1.1 and 5.0 transport binding #158

MQTT 3.1.1 and 5.0 transport binding #158

Conversation

clemensv commented Apr 12, 2018

lfourie commented Apr 19, 2018

lfourie commented Apr 19, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lfourie Apr 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lfourie Apr 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lfourie Apr 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lfourie Apr 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clemensv Apr 23, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jwende commented Apr 27, 2018

jwende commented Apr 27, 2018

jwende commented Apr 27, 2018

jwende commented Apr 27, 2018

clemensv commented May 16, 2018

jwende commented May 16, 2018

yaronha commented May 24, 2018

duglin commented May 24, 2018 • edited Loading

duglin commented May 31, 2018

duglin commented Jun 1, 2018

duglin commented Jun 1, 2018

lfourie Apr 20, 2018 •

edited

Loading

lfourie Apr 20, 2018 •

edited

Loading

lfourie Apr 20, 2018 •

edited

Loading

lfourie Apr 20, 2018 •

edited

Loading

clemensv Apr 23, 2018 •

edited

Loading

duglin commented May 24, 2018 •

edited

Loading