Updated all code comments, should be ok now.

This commit is contained in:
SeppPenner
2021-01-15 20:34:33 +01:00
parent 5eab337e13
commit bba04e2b5d
28 changed files with 197 additions and 188 deletions
-26
View File
@@ -28,62 +28,36 @@ namespace MQTTnet
/// </summary>
string _topic;
/// <summary>
/// Adds a topic to the topic filter.
/// </summary>
/// <param name="topic">The topic.</param>
/// <returns>A new instance of the <see cref="MqttTopicFilterBuilder"/> class.</returns>
public MqttTopicFilterBuilder WithTopic(string topic)
{
_topic = topic;
return this;
}
/// <summary>
/// Adds the quality of service level to the topic filter.
/// </summary>
/// <param name="qualityOfServiceLevel">The quality of service level.</param>
/// <returns>A new instance of the <see cref="MqttTopicFilterBuilder"/> class.</returns>
public MqttTopicFilterBuilder WithQualityOfServiceLevel(MqttQualityOfServiceLevel qualityOfServiceLevel)
{
_qualityOfServiceLevel = qualityOfServiceLevel;
return this;
}
/// <summary>
/// Adds the quality of service level 0 (at least once) to the topic filter.
/// </summary>
/// <returns>A new instance of the <see cref="MqttTopicFilterBuilder"/> class.</returns>
public MqttTopicFilterBuilder WithAtLeastOnceQoS()
{
_qualityOfServiceLevel = MqttQualityOfServiceLevel.AtLeastOnce;
return this;
}
/// <summary>
/// Adds the quality of service level 1 (at most once) to the topic filter.
/// </summary>
/// <returns>A new instance of the <see cref="MqttTopicFilterBuilder"/> class.</returns>
public MqttTopicFilterBuilder WithAtMostOnceQoS()
{
_qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce;
return this;
}
/// <summary>
/// Adds the quality of service level 2 (exactly once) to the topic filter.
/// </summary>
/// <returns>A new instance of the <see cref="MqttTopicFilterBuilder"/> class.</returns>
public MqttTopicFilterBuilder WithExactlyOnceQoS()
{
_qualityOfServiceLevel = MqttQualityOfServiceLevel.ExactlyOnce;
return this;
}
/// <summary>
/// Builds the topic filter.
/// </summary>
/// <returns>A new instance of the <see cref="MqttTopicFilter"/> class.</returns>
public MqttTopicFilter Build()
{
if (string.IsNullOrEmpty(_topic))