mirror of
https://github.com/dotnet/MQTTnet.git
synced 2026-10-15 17:00:03 +08:00
482 lines
20 KiB
C#
482 lines
20 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using MQTTnet.Adapter;
|
|
using MQTTnet.Client;
|
|
using MQTTnet.Diagnostics;
|
|
using MQTTnet.Exceptions;
|
|
using MQTTnet.Formatter;
|
|
using MQTTnet.PacketDispatcher;
|
|
using MQTTnet.Packets;
|
|
using MQTTnet.Protocol;
|
|
using MQTTnet.Server.Status;
|
|
|
|
namespace MQTTnet.Server
|
|
{
|
|
public class MqttClientConnection : IMqttClientSession, IDisposable
|
|
{
|
|
private readonly MqttPacketIdentifierProvider _packetIdentifierProvider = new MqttPacketIdentifierProvider();
|
|
private readonly MqttPacketDispatcher _packetDispatcher = new MqttPacketDispatcher();
|
|
private readonly CancellationTokenSource _cancellationToken = new CancellationTokenSource();
|
|
|
|
private readonly MqttRetainedMessagesManager _retainedMessagesManager;
|
|
private readonly MqttClientKeepAliveMonitor _keepAliveMonitor;
|
|
private readonly MqttClientSessionsManager _sessionsManager;
|
|
|
|
private readonly IMqttNetChildLogger _logger;
|
|
private readonly IMqttServerOptions _serverOptions;
|
|
|
|
private readonly IMqttChannelAdapter _channelAdapter;
|
|
private readonly IMqttDataConverter _dataConverter;
|
|
private readonly string _endpoint;
|
|
private readonly MqttConnectPacket _connectPacket;
|
|
|
|
private Task<MqttClientDisconnectType> _packageReceiverTask;
|
|
private DateTime _lastPacketReceivedTimestamp;
|
|
private DateTime _lastNonKeepAlivePacketReceivedTimestamp;
|
|
|
|
private long _receivedPacketsCount;
|
|
private long _sentPacketsCount = 1; // Start with 1 because the CONNECT packet is not counted anywhere.
|
|
private long _receivedApplicationMessagesCount;
|
|
private long _sentApplicationMessagesCount;
|
|
|
|
public MqttClientConnection(
|
|
MqttConnectPacket connectPacket,
|
|
IMqttChannelAdapter channelAdapter,
|
|
MqttClientSession session,
|
|
IMqttServerOptions serverOptions,
|
|
MqttClientSessionsManager sessionsManager,
|
|
MqttRetainedMessagesManager retainedMessagesManager,
|
|
IMqttNetChildLogger logger)
|
|
{
|
|
Session = session ?? throw new ArgumentNullException(nameof(session));
|
|
_serverOptions = serverOptions ?? throw new ArgumentNullException(nameof(serverOptions));
|
|
_sessionsManager = sessionsManager ?? throw new ArgumentNullException(nameof(sessionsManager));
|
|
_retainedMessagesManager = retainedMessagesManager ?? throw new ArgumentNullException(nameof(retainedMessagesManager));
|
|
|
|
_channelAdapter = channelAdapter ?? throw new ArgumentNullException(nameof(channelAdapter));
|
|
_dataConverter = _channelAdapter.PacketFormatterAdapter.DataConverter;
|
|
_endpoint = _channelAdapter.Endpoint;
|
|
_connectPacket = connectPacket ?? throw new ArgumentNullException(nameof(connectPacket));
|
|
|
|
if (logger == null) throw new ArgumentNullException(nameof(logger));
|
|
_logger = logger.CreateChildLogger(nameof(MqttClientConnection));
|
|
|
|
_keepAliveMonitor = new MqttClientKeepAliveMonitor(this, _logger);
|
|
|
|
_lastPacketReceivedTimestamp = DateTime.UtcNow;
|
|
_lastNonKeepAlivePacketReceivedTimestamp = _lastPacketReceivedTimestamp;
|
|
}
|
|
|
|
public string ClientId => _connectPacket.ClientId;
|
|
|
|
public MqttClientSession Session { get; }
|
|
|
|
public async Task StopAsync()
|
|
{
|
|
StopInternal();
|
|
|
|
var task = _packageReceiverTask;
|
|
if (task != null)
|
|
{
|
|
await task.ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
public void FillStatus(MqttClientStatus status)
|
|
{
|
|
status.ClientId = ClientId;
|
|
status.Endpoint = _endpoint;
|
|
status.ProtocolVersion = _channelAdapter.PacketFormatterAdapter.ProtocolVersion;
|
|
|
|
status.ReceivedApplicationMessagesCount = Interlocked.Read(ref _receivedApplicationMessagesCount);
|
|
status.SentApplicationMessagesCount = Interlocked.Read(ref _sentApplicationMessagesCount);
|
|
|
|
status.ReceivedPacketsCount = Interlocked.Read(ref _receivedPacketsCount);
|
|
status.SentPacketsCount = Interlocked.Read(ref _sentPacketsCount);
|
|
|
|
status.LastPacketReceivedTimestamp = _lastPacketReceivedTimestamp;
|
|
status.LastNonKeepAlivePacketReceivedTimestamp = _lastNonKeepAlivePacketReceivedTimestamp;
|
|
|
|
status.BytesSent = _channelAdapter.BytesSent;
|
|
status.BytesReceived = _channelAdapter.BytesReceived;
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
_cancellationToken.Dispose();
|
|
}
|
|
|
|
public Task<MqttClientDisconnectType> RunAsync()
|
|
{
|
|
_packageReceiverTask = RunInternalAsync();
|
|
return _packageReceiverTask;
|
|
}
|
|
|
|
private async Task<MqttClientDisconnectType> RunInternalAsync()
|
|
{
|
|
var disconnectType = MqttClientDisconnectType.NotClean;
|
|
try
|
|
{
|
|
_logger.Info("Client '{0}': Session started.", ClientId);
|
|
|
|
_channelAdapter.ReadingPacketStartedCallback = OnAdapterReadingPacketStarted;
|
|
_channelAdapter.ReadingPacketCompletedCallback = OnAdapterReadingPacketCompleted;
|
|
|
|
Session.WillMessage = _connectPacket.WillMessage;
|
|
|
|
#pragma warning disable 4014
|
|
Task.Run(() => SendPendingPacketsAsync(_cancellationToken.Token), _cancellationToken.Token);
|
|
#pragma warning restore 4014
|
|
|
|
// TODO: Change to single thread in SessionManager. Or use SessionManager and stats from KeepAliveMonitor.
|
|
_keepAliveMonitor.Start(_connectPacket.KeepAlivePeriod, _cancellationToken.Token);
|
|
|
|
await SendAsync(
|
|
new MqttConnAckPacket
|
|
{
|
|
ReturnCode = MqttConnectReturnCode.ConnectionAccepted,
|
|
ReasonCode = MqttConnectReasonCode.Success,
|
|
IsSessionPresent = Session.IsCleanSession
|
|
}).ConfigureAwait(false);
|
|
|
|
Session.IsCleanSession = false;
|
|
|
|
while (!_cancellationToken.IsCancellationRequested)
|
|
{
|
|
var packet = await _channelAdapter.ReceivePacketAsync(TimeSpan.Zero, _cancellationToken.Token).ConfigureAwait(false);
|
|
if (packet == null)
|
|
{
|
|
// The client has closed the connection gracefully.
|
|
break;
|
|
}
|
|
|
|
Interlocked.Increment(ref _sentPacketsCount);
|
|
_lastPacketReceivedTimestamp = DateTime.UtcNow;
|
|
|
|
if (!(packet is MqttPingReqPacket || packet is MqttPingRespPacket))
|
|
{
|
|
_lastNonKeepAlivePacketReceivedTimestamp = _lastPacketReceivedTimestamp;
|
|
}
|
|
|
|
_keepAliveMonitor.PacketReceived();
|
|
|
|
if (packet is MqttPublishPacket publishPacket)
|
|
{
|
|
await HandleIncomingPublishPacketAsync(publishPacket).ConfigureAwait(false);
|
|
continue;
|
|
}
|
|
|
|
if (packet is MqttPubRelPacket pubRelPacket)
|
|
{
|
|
var pubCompPacket = new MqttPubCompPacket
|
|
{
|
|
PacketIdentifier = pubRelPacket.PacketIdentifier,
|
|
ReasonCode = MqttPubCompReasonCode.Success
|
|
};
|
|
|
|
await SendAsync(pubCompPacket).ConfigureAwait(false);
|
|
continue;
|
|
}
|
|
|
|
if (packet is MqttSubscribePacket subscribePacket)
|
|
{
|
|
await HandleIncomingSubscribePacketAsync(subscribePacket).ConfigureAwait(false);
|
|
continue;
|
|
}
|
|
|
|
if (packet is MqttUnsubscribePacket unsubscribePacket)
|
|
{
|
|
await HandleIncomingUnsubscribePacketAsync(unsubscribePacket).ConfigureAwait(false);
|
|
continue;
|
|
}
|
|
|
|
if (packet is MqttPingReqPacket)
|
|
{
|
|
await SendAsync(new MqttPingRespPacket()).ConfigureAwait(false);
|
|
continue;
|
|
}
|
|
|
|
if (packet is MqttDisconnectPacket)
|
|
{
|
|
Session.WillMessage = null;
|
|
disconnectType = MqttClientDisconnectType.Clean;
|
|
|
|
StopInternal();
|
|
break;
|
|
}
|
|
|
|
_packetDispatcher.Dispatch(packet);
|
|
}
|
|
}
|
|
catch (OperationCanceledException)
|
|
{
|
|
}
|
|
catch (Exception exception)
|
|
{
|
|
if (exception is MqttCommunicationException)
|
|
{
|
|
_logger.Warning(exception, "Client '{0}': Communication exception while receiving client packets.", ClientId);
|
|
}
|
|
else
|
|
{
|
|
_logger.Error(exception, "Client '{0}': Unhandled exception while receiving client packets.", ClientId);
|
|
}
|
|
|
|
StopInternal();
|
|
}
|
|
finally
|
|
{
|
|
if (Session.WillMessage != null)
|
|
{
|
|
_sessionsManager.DispatchApplicationMessage(Session.WillMessage, this);
|
|
Session.WillMessage = null;
|
|
}
|
|
|
|
_packetDispatcher.Reset();
|
|
|
|
_channelAdapter.ReadingPacketStartedCallback = null;
|
|
_channelAdapter.ReadingPacketCompletedCallback = null;
|
|
|
|
_logger.Info("Client '{0}': Session stopped.", ClientId);
|
|
|
|
_packageReceiverTask = null;
|
|
}
|
|
|
|
return disconnectType;
|
|
}
|
|
|
|
private void StopInternal()
|
|
{
|
|
_cancellationToken.Cancel(false);
|
|
}
|
|
|
|
private async Task EnqueueSubscribedRetainedMessagesAsync(ICollection<TopicFilter> topicFilters)
|
|
{
|
|
var retainedMessages = await _retainedMessagesManager.GetSubscribedMessagesAsync(topicFilters).ConfigureAwait(false);
|
|
foreach (var applicationMessage in retainedMessages)
|
|
{
|
|
Session.EnqueueApplicationMessage(applicationMessage, ClientId, true);
|
|
}
|
|
}
|
|
|
|
private async Task HandleIncomingSubscribePacketAsync(MqttSubscribePacket subscribePacket)
|
|
{
|
|
// TODO: Let the channel adapter create the packet.
|
|
var subscribeResult = await Session.SubscriptionsManager.SubscribeAsync(subscribePacket).ConfigureAwait(false);
|
|
|
|
await SendAsync(subscribeResult.ResponsePacket).ConfigureAwait(false);
|
|
|
|
if (subscribeResult.CloseConnection)
|
|
{
|
|
StopInternal();
|
|
return;
|
|
}
|
|
|
|
await EnqueueSubscribedRetainedMessagesAsync(subscribePacket.TopicFilters).ConfigureAwait(false);
|
|
}
|
|
|
|
private async Task HandleIncomingUnsubscribePacketAsync(MqttUnsubscribePacket unsubscribePacket)
|
|
{
|
|
// TODO: Let the channel adapter create the packet.
|
|
var unsubscribeResult = await Session.SubscriptionsManager.UnsubscribeAsync(unsubscribePacket).ConfigureAwait(false);
|
|
await SendAsync(unsubscribeResult).ConfigureAwait(false);
|
|
}
|
|
|
|
private Task HandleIncomingPublishPacketAsync(MqttPublishPacket publishPacket)
|
|
{
|
|
Interlocked.Increment(ref _sentApplicationMessagesCount);
|
|
|
|
switch (publishPacket.QualityOfServiceLevel)
|
|
{
|
|
case MqttQualityOfServiceLevel.AtMostOnce:
|
|
{
|
|
return HandleIncomingPublishPacketWithQoS0Async(publishPacket);
|
|
}
|
|
case MqttQualityOfServiceLevel.AtLeastOnce:
|
|
{
|
|
return HandleIncomingPublishPacketWithQoS1Async(publishPacket);
|
|
}
|
|
case MqttQualityOfServiceLevel.ExactlyOnce:
|
|
{
|
|
return HandleIncomingPublishPacketWithQoS2Async(publishPacket);
|
|
}
|
|
default:
|
|
{
|
|
throw new MqttCommunicationException("Received a not supported QoS level.");
|
|
}
|
|
}
|
|
}
|
|
|
|
private Task HandleIncomingPublishPacketWithQoS0Async(MqttPublishPacket publishPacket)
|
|
{
|
|
var applicationMessage = _dataConverter.CreateApplicationMessage(publishPacket);
|
|
|
|
_sessionsManager.DispatchApplicationMessage(applicationMessage, this);
|
|
|
|
return Task.FromResult(0);
|
|
}
|
|
|
|
private Task HandleIncomingPublishPacketWithQoS1Async(MqttPublishPacket publishPacket)
|
|
{
|
|
var applicationMessage = _dataConverter.CreateApplicationMessage(publishPacket);
|
|
_sessionsManager.DispatchApplicationMessage(applicationMessage, this);
|
|
|
|
var pubAckPacket = _dataConverter.CreatePubAckPacket(publishPacket);
|
|
return SendAsync(pubAckPacket);
|
|
}
|
|
|
|
private Task HandleIncomingPublishPacketWithQoS2Async(MqttPublishPacket publishPacket)
|
|
{
|
|
var applicationMessage = _dataConverter.CreateApplicationMessage(publishPacket);
|
|
_sessionsManager.DispatchApplicationMessage(applicationMessage, this);
|
|
|
|
var pubRecPacket = new MqttPubRecPacket
|
|
{
|
|
PacketIdentifier = publishPacket.PacketIdentifier,
|
|
ReasonCode = MqttPubRecReasonCode.Success
|
|
};
|
|
|
|
return SendAsync(pubRecPacket);
|
|
}
|
|
|
|
private async Task SendPendingPacketsAsync(CancellationToken cancellationToken)
|
|
{
|
|
MqttQueuedApplicationMessage queuedApplicationMessage = null;
|
|
MqttPublishPacket publishPacket = null;
|
|
|
|
try
|
|
{
|
|
while (!cancellationToken.IsCancellationRequested)
|
|
{
|
|
queuedApplicationMessage = await Session.ApplicationMessagesQueue.TakeAsync(cancellationToken).ConfigureAwait(false);
|
|
if (queuedApplicationMessage == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (cancellationToken.IsCancellationRequested)
|
|
{
|
|
return;
|
|
}
|
|
|
|
publishPacket = _dataConverter.CreatePublishPacket(queuedApplicationMessage.ApplicationMessage);
|
|
publishPacket.QualityOfServiceLevel = queuedApplicationMessage.QualityOfServiceLevel;
|
|
|
|
// Set the retain flag to true according to [MQTT-3.3.1-8] and [MQTT-3.3.1-9].
|
|
publishPacket.Retain = queuedApplicationMessage.IsRetainedMessage;
|
|
|
|
if (publishPacket.QualityOfServiceLevel > 0)
|
|
{
|
|
publishPacket.PacketIdentifier = _packetIdentifierProvider.GetNextPacketIdentifier();
|
|
}
|
|
|
|
if (_serverOptions.ClientMessageQueueInterceptor != null)
|
|
{
|
|
var context = new MqttClientMessageQueueInterceptorContext(
|
|
queuedApplicationMessage.SenderClientId,
|
|
ClientId,
|
|
queuedApplicationMessage.ApplicationMessage);
|
|
|
|
if (_serverOptions.ClientMessageQueueInterceptor != null)
|
|
{
|
|
await _serverOptions.ClientMessageQueueInterceptor.InterceptClientMessageQueueEnqueueAsync(context).ConfigureAwait(false);
|
|
}
|
|
|
|
if (!context.AcceptEnqueue || context.ApplicationMessage == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
publishPacket.Topic = context.ApplicationMessage.Topic;
|
|
publishPacket.Payload = context.ApplicationMessage.Payload;
|
|
publishPacket.QualityOfServiceLevel = context.ApplicationMessage.QualityOfServiceLevel;
|
|
}
|
|
|
|
if (publishPacket.QualityOfServiceLevel == MqttQualityOfServiceLevel.AtMostOnce)
|
|
{
|
|
await SendAsync(publishPacket).ConfigureAwait(false);
|
|
}
|
|
else if (publishPacket.QualityOfServiceLevel == MqttQualityOfServiceLevel.AtLeastOnce)
|
|
{
|
|
var awaiter = _packetDispatcher.AddPacketAwaiter<MqttPubAckPacket>(publishPacket.PacketIdentifier);
|
|
await SendAsync(publishPacket).ConfigureAwait(false);
|
|
await awaiter.WaitOneAsync(_serverOptions.DefaultCommunicationTimeout).ConfigureAwait(false);
|
|
}
|
|
else if (publishPacket.QualityOfServiceLevel == MqttQualityOfServiceLevel.ExactlyOnce)
|
|
{
|
|
using (var awaiter1 = _packetDispatcher.AddPacketAwaiter<MqttPubRecPacket>(publishPacket.PacketIdentifier))
|
|
using (var awaiter2 = _packetDispatcher.AddPacketAwaiter<MqttPubCompPacket>(publishPacket.PacketIdentifier))
|
|
{
|
|
await SendAsync(publishPacket).ConfigureAwait(false);
|
|
await awaiter1.WaitOneAsync(_serverOptions.DefaultCommunicationTimeout).ConfigureAwait(false);
|
|
|
|
await SendAsync(new MqttPubRelPacket { PacketIdentifier = publishPacket.PacketIdentifier }).ConfigureAwait(false);
|
|
await awaiter2.WaitOneAsync(_serverOptions.DefaultCommunicationTimeout).ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
_logger.Verbose("Queued application message sent (ClientId: {0}).", ClientId);
|
|
|
|
// TODO:
|
|
//Interlocked.Increment(ref _sentPacketsCount);
|
|
}
|
|
}
|
|
catch (Exception exception)
|
|
{
|
|
if (exception is MqttCommunicationTimedOutException)
|
|
{
|
|
_logger.Warning(exception, "Sending publish packet failed: Timeout (ClientId: {0}).", ClientId);
|
|
}
|
|
else if (exception is MqttCommunicationException)
|
|
{
|
|
_logger.Warning(exception, "Sending publish packet failed: Communication exception (ClientId: {0}).", ClientId);
|
|
}
|
|
else if (exception is OperationCanceledException && _cancellationToken.Token.IsCancellationRequested)
|
|
{
|
|
// The cancellation was triggered externally.
|
|
}
|
|
else
|
|
{
|
|
_logger.Error(exception, "Sending publish packet failed (ClientId: {0}).", ClientId);
|
|
}
|
|
|
|
if (publishPacket?.QualityOfServiceLevel > MqttQualityOfServiceLevel.AtMostOnce)
|
|
{
|
|
queuedApplicationMessage.IsDuplicate = true;
|
|
|
|
Session.ApplicationMessagesQueue.Enqueue(queuedApplicationMessage);
|
|
}
|
|
|
|
if (!_cancellationToken.Token.IsCancellationRequested)
|
|
{
|
|
await StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
}
|
|
|
|
private async Task SendAsync(MqttBasePacket packet)
|
|
{
|
|
await _channelAdapter.SendPacketAsync(packet, _serverOptions.DefaultCommunicationTimeout, _cancellationToken.Token).ConfigureAwait(false);
|
|
|
|
Interlocked.Increment(ref _receivedPacketsCount);
|
|
|
|
if (packet is MqttPublishPacket)
|
|
{
|
|
Interlocked.Increment(ref _receivedApplicationMessagesCount);
|
|
}
|
|
}
|
|
|
|
private void OnAdapterReadingPacketCompleted()
|
|
{
|
|
_keepAliveMonitor?.Resume();
|
|
}
|
|
|
|
private void OnAdapterReadingPacketStarted()
|
|
{
|
|
_keepAliveMonitor?.Pause();
|
|
}
|
|
}
|
|
}
|