diff --git a/.github/workflows/ReleaseNotes.md b/.github/workflows/ReleaseNotes.md index 2d31e272..b590561b 100644 --- a/.github/workflows/ReleaseNotes.md +++ b/.github/workflows/ReleaseNotes.md @@ -5,6 +5,7 @@ * [Client] MQTTv5 features are now checked and an exception is thrown if they are used when using protocol version 3.1.1 and lower. These checks can be disabled in client options. (BREAKING CHANGE!). * [Client] Added support for disabling packet fragmentation (required for i.e. AWS, #1690, thanks to @logicaloud). * [Client] Added new overloads for options builder. +* [Client] Renamed _InspectPackage_ to _InspectPacketAsync_ (BREAKING CHANGE). * [ManagedClient] Exposed added and removed topics in _ManagedProcessFailedEventArgs_ (#1678, thanks to @scottbrogden-iheartmedia). * [Server] Exposed MQTT v5 sent properties from the affected client in _ClientDisconnectedAsync_ event. * [Server] Fixed wrong client ID passed to _InterceptingUnsubscriptionEventArgs_ (#1631, thanks to @ghord). diff --git a/Samples/Diagnostics/PackageInspection_Samples.cs b/Samples/Diagnostics/PackageInspection_Samples.cs index c4d4b7ac..1480246e 100644 --- a/Samples/Diagnostics/PackageInspection_Samples.cs +++ b/Samples/Diagnostics/PackageInspection_Samples.cs @@ -26,7 +26,7 @@ public static class PackageInspection_Samples .WithTcpServer("broker.hivemq.com") .Build(); - mqttClient.InspectPackage += OnInspectPackage; + mqttClient.InspectPacketAsync += OnInspectPacket; await mqttClient.ConnectAsync(mqttClientOptions, CancellationToken.None); @@ -39,7 +39,7 @@ public static class PackageInspection_Samples } } - static Task OnInspectPackage(InspectMqttPacketEventArgs eventArgs) + static Task OnInspectPacket(InspectMqttPacketEventArgs eventArgs) { if (eventArgs.Direction == MqttPacketFlowDirection.Inbound) { diff --git a/Source/MQTTnet.Tests/Diagnostics/PacketInspection_Tests.cs b/Source/MQTTnet.Tests/Diagnostics/PacketInspection_Tests.cs index 5589a37d..31ea7be5 100644 --- a/Source/MQTTnet.Tests/Diagnostics/PacketInspection_Tests.cs +++ b/Source/MQTTnet.Tests/Diagnostics/PacketInspection_Tests.cs @@ -30,7 +30,7 @@ namespace MQTTnet.Tests.Diagnostics var packets = new List(); - mqttClient.InspectPackage += eventArgs => + mqttClient.InspectPacketAsync += eventArgs => { packets.Add(eventArgs.Direction + ":" + Convert.ToBase64String(eventArgs.Buffer)); return CompletedTask.Instance; diff --git a/Source/MQTTnet.Tests/Server/General.cs b/Source/MQTTnet.Tests/Server/General.cs index 9d1b0c25..2e0061e1 100644 --- a/Source/MQTTnet.Tests/Server/General.cs +++ b/Source/MQTTnet.Tests/Server/General.cs @@ -954,7 +954,7 @@ namespace MQTTnet.Tests.Server var client = testEnvironment.CreateClient(); - client.InspectPackage += e => + client.InspectPacketAsync += e => { if (e.Buffer.Length > 0) { diff --git a/Source/MQTTnet/Client/IMqttClient.cs b/Source/MQTTnet/Client/IMqttClient.cs index 849bff12..033672d5 100644 --- a/Source/MQTTnet/Client/IMqttClient.cs +++ b/Source/MQTTnet/Client/IMqttClient.cs @@ -15,7 +15,7 @@ namespace MQTTnet.Client event Func DisconnectedAsync; - event Func InspectPackage; + event Func InspectPacketAsync; bool IsConnected { get; } diff --git a/Source/MQTTnet/Client/MqttClient.cs b/Source/MQTTnet/Client/MqttClient.cs index e6cd7fbe..876c1390 100644 --- a/Source/MQTTnet/Client/MqttClient.cs +++ b/Source/MQTTnet/Client/MqttClient.cs @@ -87,7 +87,7 @@ namespace MQTTnet.Client remove => _disconnectedEvent.RemoveHandler(value); } - public event Func InspectPackage + public event Func InspectPacketAsync { add => _inspectPacketEvent.AddHandler(value); remove => _inspectPacketEvent.RemoveHandler(value); diff --git a/Source/MQTTnet/LowLevelClient/ILowLevelMqttClient.cs b/Source/MQTTnet/LowLevelClient/ILowLevelMqttClient.cs index 40132f28..00933381 100644 --- a/Source/MQTTnet/LowLevelClient/ILowLevelMqttClient.cs +++ b/Source/MQTTnet/LowLevelClient/ILowLevelMqttClient.cs @@ -9,7 +9,7 @@ namespace MQTTnet.LowLevelClient { public interface ILowLevelMqttClient : IDisposable { - event Func InspectPackage; + event Func InspectPacketAsync; bool IsConnected { get; } diff --git a/Source/MQTTnet/LowLevelClient/LowLevelMqttClient.cs b/Source/MQTTnet/LowLevelClient/LowLevelMqttClient.cs index a70b58da..75074320 100644 --- a/Source/MQTTnet/LowLevelClient/LowLevelMqttClient.cs +++ b/Source/MQTTnet/LowLevelClient/LowLevelMqttClient.cs @@ -32,7 +32,7 @@ namespace MQTTnet.LowLevelClient _logger = logger.WithSource(nameof(LowLevelMqttClient)); } - public event Func InspectPackage + public event Func InspectPacketAsync { add => _inspectPacketEvent.AddHandler(value); remove => _inspectPacketEvent.RemoveHandler(value); @@ -52,13 +52,19 @@ namespace MQTTnet.LowLevelClient throw new InvalidOperationException("Low level MQTT client is already connected. Disconnect first before connecting again."); } - var newAdapter = _clientAdapterFactory.CreateClientAdapter(options, new MqttPacketInspector(_inspectPacketEvent, _rootLogger), _rootLogger); + MqttPacketInspector packetInspector = null; + if (_inspectPacketEvent.HasHandlers) + { + packetInspector = new MqttPacketInspector(_inspectPacketEvent, _rootLogger); + } + + var newAdapter = _clientAdapterFactory.CreateClientAdapter(options, packetInspector, _rootLogger); try { - _logger.Verbose("Trying to connect with server '{0}'.", options.ChannelOptions); + _logger.Verbose("Trying to connect with server '{0}'", options.ChannelOptions); await newAdapter.ConnectAsync(cancellationToken).ConfigureAwait(false); - _logger.Verbose("Connection with server established."); + _logger.Verbose("Connection with server established"); } catch (Exception) {