MQTTnet.AspNetCore.AttributeRouting 0.3.16

.NET 5.0 .NET Core 3.1 .NET Standard 2.0

dotnet add package MQTTnet.AspNetCore.AttributeRouting --version 0.3.16

NuGet\Install-Package MQTTnet.AspNetCore.AttributeRouting -Version 0.3.16

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="MQTTnet.AspNetCore.AttributeRouting" Version="0.3.16" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add MQTTnet.AspNetCore.AttributeRouting --version 0.3.16

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: MQTTnet.AspNetCore.AttributeRouting, 0.3.16"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install MQTTnet.AspNetCore.AttributeRouting as a Cake Addin
#addin nuget:?package=MQTTnet.AspNetCore.AttributeRouting&version=0.3.16

// Install MQTTnet.AspNetCore.AttributeRouting as a Cake Tool
#tool nuget:?package=MQTTnet.AspNetCore.AttributeRouting&version=0.3.16

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

MQTTnet AspNetCore AttributeRouting

This addon to MQTTnet provides the ability to define controllers and use attribute-based routing against message topics in a manner that is very similar to AspNet Core.

When should I use this library?

This library is a completely optional addon to MQTTnet (i.e. it is never required). You would WANT to use this if:

Your primary use case is validating/processing the MQTT messages on your server
Your server is not primarily sending data to clients via MQTT
You appreciate encapsulating your message processing logic in controllers in a way similar to AspNetCore and WebAPI

You can do everything that this addon does directly by using MQTTnet delegates yourself. However, as the amount of logic you write to validate or process incoming messages grows, the ability to organize your logic into controllers start to make much more sense. This library helps with organizing that code as well as bringing together your dependency injection framework to MQTTnet.

Features

Encapsulate your incoming message logic in controllers
Use familiar paradigms from AspNetCore in your MQTT logic (Controllers and Actions)
First-class support for dependency injection using existing ServiceProvider implementaiton in your AspNetCore project
Support for sync and async/await Actions on your controllers
Use together with any other MQTTnet options

Performance Note

This library has not been tested against a very high-load environment yet. Ensure you do your own load testing prior to use in production. All performance improvement PRs are welcome.

Supported frameworks

.NET Standard 2.0+
.NET Core 3.1+

Supported MQTT versions

5.0.0
3.1.1
3.1.0

Nuget

This library is available as a nuget package: https://www.nuget.org/packages/MQTTnet.AspNetCore.AttributeRouting/

Usage

Install this package and MQTTnet from nuget.

Modify your Startup.cs with the following options:

public void ConfigureServices(IServiceCollection services)
{
	// ... All your other configuration ...

	// Identify and build routes
	services.AddMqttControllers(
		/*
			By default, all controllers within the executing assembly are
			discovered (just pass nothing here). To provide a list of assemblies
			explicitly, pass an array of Assembly[] here.
		*/
	);

	services
		.AddHostedMqttServerWithServices(s =>
		{
			// Optionally set server options here
			s.WithoutDefaultEndpoint();

			// Enable Attribute routing
			s.WithAttributeRouting(
				/* 
					By default, messages published to topics that don't
					match any routes are rejected. Change this to true
					to allow those messages to be routed without hitting
					any controller actions.
				*/
				allowUnmatchedRoutes: false
			);
		})
		.AddMqttConnectionHandler()
		.AddConnections();
}

Create your controllers by inheriting from MqttBaseController and adding actions to it like so:

[MqttController]
[MqttRoute("[controller]")] // Optional route prefix
public class MqttWeatherForecastController : MqttBaseController // Inherit from MqttBaseController for convenience functions
{
	private readonly ILogger<MqttWeatherForecastController> _logger;

	// Controllers have full support for dependency injection just like AspNetCore controllers
	public MqttWeatherForecastController(ILogger<MqttWeatherForecastController> logger)
	{
		_logger = logger;
	}

	// Supports template routing with typed constraints just like AspNetCore
	// Action routes compose together with the route prefix on the controller level
	[MqttRoute("{zipCode:int}/temperature")]
	public Task WeatherReport(int zipCode)
	{
		// We have access to the MqttContext
		if (zipCode != 90210) { MqttContext.CloseConnection = true; }

		// We have access to the raw message
		var temperature = BitConverter.ToDouble(Message.Payload);

		_logger.LogInformation($"It's {temperature} degrees in Hollywood");

		// Example validation
		if (temperature <= 0 || temperature >= 130)
		{
			return BadMessage();
		}

		return Ok();
	}
}

See a full example project here

Contributions

Contributions are welcome. Please open an issue to discuss your idea prior to sending a PR.

MIT License

See https://github.com/Atlas-LiftTech/MQTTnet.AspNetCore.AttributeRouting/LICENSE.

About Atlas LiftTech

This library is sponsored by Atlas Lift Tech. Atlas Lift Tech is a safe patient handling and mobility (SPHM) solution provider, helping hospitals improve patient outcomes and improve patient mobility.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 is compatible.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Additional computed target framework(s)

Learn more about Target Frameworks and .NET Standard.

.NETCoreApp 3.1
- Microsoft.AspNetCore.Mvc.Core (>= 2.2.5)
- Microsoft.Bcl.HashCode (>= 1.1.1)
- MQTTnet (>= 3.0.16)
- MQTTnet.AspNetCore (>= 3.0.16)
.NETStandard 2.0
- Microsoft.AspNetCore.Http.Connections (>= 1.1.0)
- Microsoft.AspNetCore.Mvc.Core (>= 2.2.5)
- Microsoft.Bcl.HashCode (>= 1.1.1)
- MQTTnet (>= 3.0.16)
- MQTTnet.AspNetCore (>= 3.0.16)
net5.0
- Microsoft.AspNetCore.Mvc.Core (>= 2.2.5)
- Microsoft.Bcl.HashCode (>= 1.1.1)
- MQTTnet (>= 3.0.16)
- MQTTnet.AspNetCore (>= 3.0.16)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
0.3.16	5,081	10/18/2021
0.3.15	1,422	5/12/2021
0.3.14	570	2/12/2021
0.3.13	1,562	10/27/2020
0.3.0	1,472	8/14/2020
0.2.0	451	8/13/2020
0.1.0	479	8/12/2020

* Added support for passing an array of assemblies to use in route discovery