Skip to content

Commit

Permalink
Add documentation for topicMatchesSub
Browse files Browse the repository at this point in the history
  • Loading branch information
mgdm committed Nov 1, 2013
1 parent 4e3c8d4 commit ea06cb5
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ a callback to return from the loop.
### Class Mosquitto\Message

Represents a message received from a broker. All data is represented as
properties. The class has no methods.
properties.

| Property | Type | Description |
| --- | --- | --- |
Expand All @@ -310,6 +310,18 @@ properties. The class has no methods.
| qos | int | The QoS value applied to this message. |
| retain | bool | Whether this is a retained message or not. |

This class has one static method.

#### topicMatchesSub

Returns true if the supplied topic matches the supplied description, and
otherwise false.

| Parameter | Type | Description |
| --- | --- | ---- |
| topic | string | The topic to match |
| subscription | string | The subscription to match |

### Class Mosquitto\Exception

This is an exception that may be thrown by many of the operations in the Client
Expand Down

0 comments on commit ea06cb5

Please sign in to comment.