MQTTnet/Source/MQTTnet.Server/Events/InterceptingPacketEventArgs.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System.Collections;
using System.Net;
using MQTTnet.Packets;

namespace MQTTnet.Server;

public sealed class InterceptingPacketEventArgs : EventArgs
{
    public InterceptingPacketEventArgs(string clientId, string userName, EndPoint remoteEndPoint, MqttPacket packet, IDictionary sessionItems, CancellationToken cancellationToken)
    {
        CancellationToken = cancellationToken;
        ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
        UserName = userName;
        RemoteEndPoint = remoteEndPoint;
        Packet = packet ?? throw new ArgumentNullException(nameof(packet));
        SessionItems = sessionItems;
    }

    /// <summary>
    ///     Gets the cancellation token from the connection managing thread.
    ///     Use this in further event processing.
    /// </summary>
    public CancellationToken CancellationToken { get; }

    /// <summary>
    ///     Gets the client ID which has sent the packet or will receive the packet.
    /// </summary>
    public string ClientId { get; }

    /// <summary>
    /// Gets the user name of the client.
    /// </summary>
    public string UserName { get; }

    /// <summary>
    ///     Gets the endpoint of the sending or receiving client.
    /// </summary>
    public EndPoint RemoteEndPoint { get; }

    [Obsolete("Use RemoteEndPoint instead.")]
    public string Endpoint => RemoteEndPoint?.ToString();

    /// <summary>
    ///     Gets or sets the MQTT packet which was received or will be sent.
    /// </summary>
    public MqttPacket Packet { get; set; }

    /// <summary>
    ///     Gets or sets whether the packet should be processed or not.
    /// </summary>
    public bool ProcessPacket { get; set; } = true;

    /// <summary>
    ///     Gets or sets a key/value collection that can be used to share data within the scope of this session.
    /// </summary>
    public IDictionary SessionItems { get; }
}