public class MqttClientSubscribeResult()

in dotnet/src/Azure.Iot.Operations.Protocol/Models/MqttClientSubscribeResult.cs [10:95]


    public class MqttClientSubscribeResult(ushort packetIdentifier, IReadOnlyCollection<MqttClientSubscribeResultItem> items, string reasonString, IReadOnlyCollection<MqttUserProperty> userProperties)
    {

        /// <summary>
        /// Gets the result for every topic filter item.
        /// </summary>
        public IReadOnlyCollection<MqttClientSubscribeResultItem> Items { get; } = items ?? throw new ArgumentNullException(nameof(items));

        /// <summary>
        /// Gets the user properties which were part of the SUBACK packet.
        /// <remarks>MQTT 5.0.0+ feature.</remarks>
        /// </summary>
        public IReadOnlyCollection<MqttUserProperty> UserProperties { get; } = userProperties ?? throw new ArgumentNullException(nameof(userProperties));

        /// <summary>
        /// Gets the reason string.
        /// <remarks>MQTT 5.0.0+ feature.</remarks>
        /// </summary>
        public string ReasonString { get; } = reasonString;

        /// <summary>
        /// Gets the packet identifier which was used.
        /// </summary>
        public ushort PacketIdentifier { get; } = packetIdentifier;

        public void ThrowIfNotSuccessSubAck(MqttQualityOfServiceLevel requestedQos, string? commandName = default)
        {
            if (Items == null || Items.Count == 0)
            {
                throw new AkriMqttException("Received no items in the subscribing result, so the subscription was unsuccessful.")
                {
                    Kind = AkriMqttErrorKind.MqttError,
                    IsShallow = false,
                    IsRemote = false,
                    CommandName = commandName,
                };
            }

            foreach (MqttClientSubscribeResultItem? sub in Items)
            {
                if (!IsSubscriptionSuccessful(sub, requestedQos))
                {
                    throw new AkriMqttException($"Failed to subscribe to topic '{sub.TopicFilter.Topic}' because {sub.ReasonCode}.")
                    {
                        Kind = AkriMqttErrorKind.MqttError,
                        IsShallow = false,
                        IsRemote = false,
                        CommandName = commandName,
                    };
                }
            }
        }

        public bool IsSubAckSuccessful(MqttQualityOfServiceLevel requestedQos)
        {
            if (Items == null || Items.Count == 0)
            {
                return false;
            }

            foreach (MqttClientSubscribeResultItem? sub in Items)
            {
                if (!IsSubscriptionSuccessful(sub, requestedQos))
                {
                    return false;
                }
            }

            return true;
        }

        private static bool IsSubscriptionSuccessful(MqttClientSubscribeResultItem subscribeResultItem, MqttQualityOfServiceLevel requestedQos)
        {
            MqttClientSubscribeReasonCode resultCode = subscribeResultItem.ReasonCode;

            // The granted QoS level is different from the requested QoS level
            if (((Int32)resultCode).CompareTo((Int32)requestedQos) != 0)
            {
                Trace.TraceWarning($"The granted QoS level [{resultCode}] is different from the requested QoS level [{requestedQos}].");
            }

            return resultCode is MqttClientSubscribeReasonCode.GrantedQoS0
                or MqttClientSubscribeReasonCode.GrantedQoS1
                or MqttClientSubscribeReasonCode.GrantedQoS2;
        }
    }