YangWX/MQTTnet
1
0
Fork 0
mirror of https://github.com/dotnet/MQTTnet.git synced 2026-10-21 12:16:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated all code comments, should be ok now.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
Source/MQTTnet/MqttApplicationMessageBuilder.cs
-61
View File
@@ -106,33 +106,18 @@ namespace MQTTnet
/// Hint: MQTT 5 feature only.
private List<MqttUserProperty> _userProperties;
/// <summary>
/// Adds a topic to the message.
/// </summary>
/// <param name="topic">The topic.</param>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithTopic(string topic)
{
_topic = topic;
return this;
}
/// <summary>
/// Adds a payload to the message.
/// </summary>
/// <param name="payload">The payload.</param>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithPayload(byte[] payload)
{
_payload = payload;
return this;
}
/// <summary>
/// Adds a payload to the message.
/// </summary>
/// <param name="payload">The payload.</param>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithPayload(IEnumerable<byte> payload)
{
if (payload == null)
@@ -151,11 +136,6 @@ namespace MQTTnet
return this;
}
/// <summary>
/// Adds a payload to the message.
/// </summary>
/// <param name="payload">The payload.</param>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithPayload(Stream payload)
{
if (payload == null)
@@ -167,12 +147,6 @@ namespace MQTTnet
return WithPayload(payload, payload.Length - payload.Position);
}
/// <summary>
/// Adds a payload to the message.
/// </summary>
/// <param name="payload">The payload.</param>
/// <param name="length">The stream length.</param>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithPayload(Stream payload, long length)
{
if (payload == null)
@@ -194,11 +168,6 @@ namespace MQTTnet
return this;
}
/// <summary>
/// Adds a payload to the message.
/// </summary>
/// <param name="payload">The payload.</param>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithPayload(string payload)
{
if (payload == null)
@@ -211,22 +180,12 @@ namespace MQTTnet
return this;
}
/// <summary>
/// Adds the quality of service level to the message.
/// </summary>
/// <param name="qualityOfServiceLevel">The quality of service level.</param>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithQualityOfServiceLevel(MqttQualityOfServiceLevel qualityOfServiceLevel)
{
_qualityOfServiceLevel = qualityOfServiceLevel;
return this;
}
/// <summary>
/// Adds the quality of service level to the message.
/// </summary>
/// <param name="qualityOfServiceLevel">The quality of service level.</param>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithQualityOfServiceLevel(int qualityOfServiceLevel)
{
if (qualityOfServiceLevel < 0 || qualityOfServiceLevel > 2)
@@ -237,40 +196,24 @@ namespace MQTTnet
return WithQualityOfServiceLevel((MqttQualityOfServiceLevel)qualityOfServiceLevel);
}
/// <summary>
/// Adds retain flag to the message.
/// </summary>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithRetainFlag(bool value = true)
{
_retain = value;
return this;
}
/// <summary>
/// Adds the quality of service level 0 (at least once) to the message.
/// </summary>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithAtLeastOnceQoS()
{
_qualityOfServiceLevel = MqttQualityOfServiceLevel.AtLeastOnce;
return this;
}
/// <summary>
/// Adds the quality of service level 1 (at most once) to the message.
/// </summary>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithAtMostOnceQoS()
{
_qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce;
return this;
}
/// <summary>
/// Adds the quality of service level 2 (exactly once) to the message.
/// </summary>
/// <returns>A new instance of the <see cref="MqttApplicationMessageBuilder"/> class.</returns>
public MqttApplicationMessageBuilder WithExactlyOnceQoS()
{
_qualityOfServiceLevel = MqttQualityOfServiceLevel.ExactlyOnce;
@@ -383,10 +326,6 @@ namespace MQTTnet
return this;
}
/// <summary>
/// Builds the message.
/// </summary>
/// <returns>A new instance of the <see cref="MqttApplicationMessage"/> class.</returns>
public MqttApplicationMessage Build()
{
if (!_topicAlias.HasValue && string.IsNullOrEmpty(_topic))