Skip to content

Commit

Permalink
Add Namespaces and Getting Help page
Browse files Browse the repository at this point in the history
  • Loading branch information
pglombardo committed Dec 20, 2023
1 parent d8c97b9 commit 3504b2e
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 2 deletions.
21 changes: 21 additions & 0 deletions Documentation/docs/events/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,27 @@ sidebar_position: 2

The following serves as a few examples on how to utilize the built in event system.

## Pattern

All events are available on the client instance: `client.<event_name>`. Handlers can be assigned to the event by simply adding your handler to the list:

```csharp
client.AfterDisconnect += MyAfterDisconnectHAndler
```

...where `MyAfterDisconnectHandler` is an already-defined function in my application.

### Lambdas

An alternative to using a pre-defined function are lambdas:

```csharp
client.AfterUnsubscribe += (sender, args) =>
{
// code
}
```

## Display Options Prior to Connecting

This example simply prints out the `HiveMQClientOptions` prior to the connect command being sent to the broker.
Expand Down
26 changes: 26 additions & 0 deletions Documentation/docs/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
sidebar_position: 6
---

# Getting Help

## Community Forum

Visit the [HiveMQ Community Forum](https://community.hivemq.com/) to engage with a vibrant community of users, developers, and experts. The forum is an excellent place to ask questions, share your experiences, and collaborate with others who use or contribute to HiveMQ. Explore existing topics, participate in discussions, and seek assistance from the community.

## GitHub Repository

For technical issues, bug reports, or feature requests related to the HiveMQ MQTT Client for .NET, visit our [GitHub repository](https://github.com/hivemq/hivemq-mqtt-client-dotnet). You can open new issues, contribute to ongoing discussions, and submit pull requests. Our development team actively monitors the repository, and the GitHub platform serves as a collaborative space for the community.

## Professional Support

If you require professional assistance or have specific support needs, consider reaching out to our [official support channels](https://www.hivemq.com/support/). Our support team is dedicated to helping you resolve issues, optimize your implementation, and ensure a smooth experience with HiveMQ. Explore the available support plans and choose the one that best suits your requirements.

## Additional Resources

- [HiveMQ Website](https://www.hivemq.com/): Explore our official website for comprehensive information about HiveMQ, its features, and the MQTT protocol.
- [Documentation](https://www.hivemq.com/docs/): Access detailed documentation to better understand HiveMQ's capabilities and configuration options.
- [Blog](https://www.hivemq.com/blog/): Stay updated on the latest developments, best practices, and MQTT insights by reading our blog posts.

For any other inquiries or general information, feel free to [contact us](https://www.hivemq.com/contact/). We value your engagement with the HiveMQ community and are here to assist you on your MQTT journey!

4 changes: 2 additions & 2 deletions Documentation/docs/namespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ using HiveMQtt.MQTT5.Types;
| `HiveMQtt.Client.Exceptions` | HiveMQtt Exceptions. | `HiveMQttClientException` |
| `HiveMQtt.Client.ReasonCodes` | Reason code exceptions. | `QoS1ReasonCode`, `QoS2ReasonCode`|
| `HiveMQtt.Client.Results` | Result classes.| `ConnectResult`, `PublishResult`, `SubscribeResult`, `UnsubscribeResult`|
| `HiveMQtt.MQTT5.Types` | MQTT protocol types.| `QualityOfService`, `RetainHandling`, `TopicFilter` etc...|
| `HiveMQtt.MQTT5.Packets` | MQTT packet classes. | `ConnectPacket`, `PingReqPacket` etc...|
| `HiveMQtt.MQTT5.ReasonCodes` | Packet level reason code exceptions. | `ConnAckReasonCode`, `PubRecReasonCode`|
| `HiveMQtt.MQTT5.Types` | MQTT protocol types.| |
| `HiveMQtt.MQTT5.ReasonCodes` | Packet level reason codes. | `ConnAckReasonCode`, `PubRecReasonCode`|

0 comments on commit 3504b2e

Please sign in to comment.