Skip to content

Commit 5a1000f

Browse files
committed
[eclipse-hono#2584] Describe usage of wild cards in MQTT topic filters
Fixes eclipse-hono#2584 Signed-off-by: Kai Hudalla <[email protected]>
1 parent 40c7f40 commit 5a1000f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

site/documentation/content/user-guide/mqtt-adapter.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,8 @@ For *Request/Response* commands, devices send their responses to commands by mea
268268

269269
The MQTT adapter checks the configured [message limit]({{< relref "/concepts/resource-limits.md" >}}) before accepting any command requests and responses. In case of incoming command requests from business applications, if the message limit is exceeded, the Adapter rejects the message with the reason `amqp:resource-limit-exceeded`. And for the incoming command responses from devices, the Adapter rejects the message and closes the connection to the client.
270270

271-
The following sections define the topic filters/names to use for subscribing to and responding to commands. The following *shorthand* versions of topic path segments are supported:
271+
The following sections define the topic filters/names to use for subscribing to and responding to commands.
272+
The following *shorthand* versions of topic path segments are supported:
272273

273274
* `c` instead of `command`
274275
* `q` instead of `req`
@@ -280,6 +281,12 @@ The following variables are used:
280281
* `${req-id}` (only for *Request/Response* commands) : The unique identifier of the command execution request. The identifier is passed to the device as part of the name of the topic that the command is published to. The device needs to publish its response to the command to a topic which includes this identifier, thus allowing the adapter to correlate the response with the request.
281282
* `${status}` : The HTTP status code indicating the outcome of executing the command. This status code is passed on to the application in the AMQP message's *status* application property.
282283

284+
{{% note title="Wild card characters in topic filters" %}}
285+
The topic filters defined below make use of MQTT's wild card characters in certain places of topic filters.
286+
However, the MQTT adapter does **not** support the general usage of wild card characters in topic filters in any
287+
other way than defined below.
288+
{{% /note %}}
289+
283290
### Receiving Commands (authenticated Device)
284291

285292
An authenticated device MUST use the following topic filter for subscribing to commands:

0 commit comments

Comments
 (0)