Skip to content

Upgrade Guide

This guide is designed to help users seamlessly transition from Best HTTP/2 to the new major release (v3.x). If you're updating your package, please read through the relevant sections to ensure a smooth upgrade.

Pre-upgrade Checklist

  • Backup Your Project: Always create a backup of your entire project before starting the upgrade process. This allows you to revert changes if something goes awry.
  • Review Deprecated Features: Check if you're using any features or methods that were marked as deprecated in the last release. Transition away from these first.

Post-upgrade Steps

  • Update API Calls: If the new version introduced new methods or altered existing ones, update your calls accordingly.
  • Test Extensively: After upgrading, test all functionalities in your project that utilize the Best MQTT package to ensure they work as expected.

List of Breaking Changes

I have worked hard to enhance features, fix issues, and introduce new capabilities - here's what you need to know:

1. Namespace changes

Instead of one big package the new version is split into multiple packages. This packaging change is reflected in how the plugins' namespaces are named. MQTT got its own namespace Best.MQTT, upgrading namespace usings can be done by replacing BestMQTT to Best.MQTT.

Example
1
2
3
4
5
6
7
using BestMQTT;
using BestMQTT.Packets.Builders;

var options = new ConnectionOptionsBuilder()
                .WithTCP("broker.emqx.io", 1883)
                .Build();
var client = new MQTTClient(options);

1
2
3
4
5
6
7
using Best.MQTT;
using Best.MQTT.Packets.Builders;

var options = new ConnectionOptionsBuilder()
                .WithTCP("broker.emqx.io", 1883)
                .Build();
var client = new MQTTClient(options);

General Tips

  1. Stay Updated on Documentation: Keep an eye on the official documentation for the Best MQTT package. It's regularly updated with new information, tutorials, and solutions to common problems.
  2. Engage with the Community: Join discussions on our Community and Support page to share your experiences, ask questions, and get advice on the upgrade process.
  3. Check for Updates Regularly: Ensure you always have the latest features, improvements, and bug fixes by regularly checking for updates.

Comments