From 5eab337e13d909e462d3d6a7b17f64133ddc7d47 Mon Sep 17 00:00:00 2001 From: SeppPenner Date: Fri, 15 Jan 2021 19:41:45 +0100 Subject: [PATCH] Removed not needed comments on client side (Server side is still missing). --- .../Connecting/IMqttClientConnectedHandler.cs | 5 - .../MqttClientAuthenticateResult.cs | 33 ---- .../IMqttClientDisconnectedHandler.cs | 5 - .../MqttClientDisconnectedEventArgs.cs | 6 - ...ttExtendedAuthenticationExchangeHandler.cs | 5 - ...ttExtendedAuthenticationExchangeContext.cs | 3 - Source/MQTTnet/Client/IMqttClient.cs | 32 ---- Source/MQTTnet/Client/IMqttClientFactory.cs | 45 ----- .../Client/Options/IMqttClientOptions.cs | 18 -- ...entCertificateValidationCallbackContext.cs | 12 -- .../Client/Options/MqttClientOptions.cs | 18 -- .../Options/MqttClientOptionsBuilder.cs | 167 ------------------ .../Publishing/MqttClientPublishResult.cs | 3 - .../IMqttApplicationMessageReceivedHandler.cs | 5 - .../MqttClientSubscribeOptionsBuilder.cs | 33 ---- .../MqttClientUnsubscribeOptionsBuilder.cs | 14 -- 16 files changed, 404 deletions(-) diff --git a/Source/MQTTnet/Client/Connecting/IMqttClientConnectedHandler.cs b/Source/MQTTnet/Client/Connecting/IMqttClientConnectedHandler.cs index 233ee577..8b7be27e 100644 --- a/Source/MQTTnet/Client/Connecting/IMqttClientConnectedHandler.cs +++ b/Source/MQTTnet/Client/Connecting/IMqttClientConnectedHandler.cs @@ -4,11 +4,6 @@ namespace MQTTnet.Client.Connecting { public interface IMqttClientConnectedHandler { - /// - /// Handles the events when a client gets connected. - /// - /// The event args. - /// A representing any asynchronous operation. Task HandleConnectedAsync(MqttClientConnectedEventArgs eventArgs); } } diff --git a/Source/MQTTnet/Client/Connecting/MqttClientAuthenticateResult.cs b/Source/MQTTnet/Client/Connecting/MqttClientAuthenticateResult.cs index dfcaaff1..ecb1293c 100644 --- a/Source/MQTTnet/Client/Connecting/MqttClientAuthenticateResult.cs +++ b/Source/MQTTnet/Client/Connecting/MqttClientAuthenticateResult.cs @@ -13,24 +13,12 @@ namespace MQTTnet.Client.Connecting /// public MqttClientConnectResultCode ResultCode { get; set; } - /// - /// Gets or sets a value indicating whether the session is present or not. - /// public bool IsSessionPresent { get; set; } - /// - /// Gets or sets a value indicating whether wildcard subscriptions are available. - /// public bool? WildcardSubscriptionAvailable { get; set; } - /// - /// Gets or sets a value indicating whether retained messages are available. - /// public bool? RetainAvailable { get; set; } - /// - /// Gets or sets the assigned client identifier. - /// public string AssignedClientIdentifier { get; set; } /// @@ -45,9 +33,6 @@ namespace MQTTnet.Client.Connecting /// public byte[] AuthenticationData { get; set; } - /// - /// Gets or sets the maximum packet size. - /// public uint? MaximumPacketSize { get; set; } /// @@ -56,14 +41,8 @@ namespace MQTTnet.Client.Connecting /// public string ReasonString { get; set; } - /// - /// Gets or sets the receive maximum. - /// public ushort? ReceiveMaximum { get; set; } - /// - /// Gets or sets the maximum quality od service level. - /// public MqttQualityOfServiceLevel MaximumQoS { get; set; } /// @@ -72,24 +51,12 @@ namespace MQTTnet.Client.Connecting /// public string ResponseInformation { get; set; } - /// - /// Gets or sets the topic alias maximum. - /// public ushort? TopicAliasMaximum { get; set; } - /// - /// Gets or sets the server reference. - /// public string ServerReference { get; set; } - /// - /// Gets or sets the server keep alive. - /// public ushort? ServerKeepAlive { get; set; } - /// - /// Gets or sets the session expiry interval. - /// public uint? SessionExpiryInterval { get; set; } /// diff --git a/Source/MQTTnet/Client/Disconnecting/IMqttClientDisconnectedHandler.cs b/Source/MQTTnet/Client/Disconnecting/IMqttClientDisconnectedHandler.cs index 81e0b9ba..14347bf0 100644 --- a/Source/MQTTnet/Client/Disconnecting/IMqttClientDisconnectedHandler.cs +++ b/Source/MQTTnet/Client/Disconnecting/IMqttClientDisconnectedHandler.cs @@ -4,11 +4,6 @@ namespace MQTTnet.Client.Disconnecting { public interface IMqttClientDisconnectedHandler { - /// - /// Handles the events when a client gets disconnected. - /// - /// The event args. - /// A representing any asynchronous operation. Task HandleDisconnectedAsync(MqttClientDisconnectedEventArgs eventArgs); } } diff --git a/Source/MQTTnet/Client/Disconnecting/MqttClientDisconnectedEventArgs.cs b/Source/MQTTnet/Client/Disconnecting/MqttClientDisconnectedEventArgs.cs index aa026342..932f009c 100644 --- a/Source/MQTTnet/Client/Disconnecting/MqttClientDisconnectedEventArgs.cs +++ b/Source/MQTTnet/Client/Disconnecting/MqttClientDisconnectedEventArgs.cs @@ -15,14 +15,8 @@ namespace MQTTnet.Client.Disconnecting ReasonCode = reason; } - /// - /// Gets a value indicating whether the client was connected or not. - /// public bool ClientWasConnected { get; } - /// - /// Gets the exception. - /// public Exception Exception { get; } /// diff --git a/Source/MQTTnet/Client/ExtendedAuthenticationExchange/IMqttExtendedAuthenticationExchangeHandler.cs b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/IMqttExtendedAuthenticationExchangeHandler.cs index 69a689cc..8cd35420 100644 --- a/Source/MQTTnet/Client/ExtendedAuthenticationExchange/IMqttExtendedAuthenticationExchangeHandler.cs +++ b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/IMqttExtendedAuthenticationExchangeHandler.cs @@ -4,11 +4,6 @@ namespace MQTTnet.Client.ExtendedAuthenticationExchange { public interface IMqttExtendedAuthenticationExchangeHandler { - /// - /// Handles the authentication request. - /// - /// The context. - /// A representing any asynchronous operation. Task HandleRequestAsync(MqttExtendedAuthenticationExchangeContext context); } } diff --git a/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeContext.cs b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeContext.cs index a83576db..082e9a8d 100644 --- a/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeContext.cs +++ b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeContext.cs @@ -53,9 +53,6 @@ namespace MQTTnet.Client.ExtendedAuthenticationExchange /// public List UserProperties { get; } - /// - /// Gets the client. - /// public IMqttClient Client { get; } } } diff --git a/Source/MQTTnet/Client/IMqttClient.cs b/Source/MQTTnet/Client/IMqttClient.cs index 95ee1d92..dbe005a0 100644 --- a/Source/MQTTnet/Client/IMqttClient.cs +++ b/Source/MQTTnet/Client/IMqttClient.cs @@ -12,9 +12,6 @@ namespace MQTTnet.Client { public interface IMqttClient : IApplicationMessageReceiver, IApplicationMessagePublisher, IDisposable { - /// - /// Gets a value indicating whether the client is connected or not. - /// bool IsConnected { get; } /// @@ -35,27 +32,10 @@ namespace MQTTnet.Client /// IMqttClientDisconnectedHandler DisconnectedHandler { get; set; } - /// - /// Connects the client to the server using the specified options. - /// - /// The options that can be used on connect. - /// A cancellation token to stop the task. - /// A result containing the authentication result information. Task ConnectAsync(IMqttClientOptions options, CancellationToken cancellationToken); - /// - /// Disconnects the client from the server. - /// - /// The options containing a disconnect reason. - /// A cancellation token to stop the task. - /// A representing any asynchronous operation. Task DisconnectAsync(MqttClientDisconnectOptions options, CancellationToken cancellationToken); - /// - /// Pings the server. - /// - /// A cancellation token to stop the task. - /// A representing any asynchronous operation. Task PingAsync(CancellationToken cancellationToken); /// @@ -67,20 +47,8 @@ namespace MQTTnet.Client /// A representing any asynchronous operation. Task SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData data, CancellationToken cancellationToken); - /// - /// Subscribes the client to topics. - /// - /// The subscription options. - /// A cancellation token to stop the task. - /// A representing any asynchronous operation. Task SubscribeAsync(MqttClientSubscribeOptions options, CancellationToken cancellationToken); - /// - /// Unsubscribes the client from topics. - /// - /// The unsubscription options. - /// A cancellation token to stop the task. - /// A representing any asynchronous operation. Task UnsubscribeAsync(MqttClientUnsubscribeOptions options, CancellationToken cancellationToken); } } \ No newline at end of file diff --git a/Source/MQTTnet/Client/IMqttClientFactory.cs b/Source/MQTTnet/Client/IMqttClientFactory.cs index 54707fff..4bbb79a3 100644 --- a/Source/MQTTnet/Client/IMqttClientFactory.cs +++ b/Source/MQTTnet/Client/IMqttClientFactory.cs @@ -6,67 +6,22 @@ namespace MQTTnet.Client { public interface IMqttClientFactory { - /// - /// A method to tell the client to use the adapter factory. - /// - /// The client adapter factory. - /// A new . IMqttFactory UseClientAdapterFactory(IMqttClientAdapterFactory clientAdapterFactory); - /// - /// Creates a new low level MQTT client. - /// - /// A new . ILowLevelMqttClient CreateLowLevelMqttClient(); - /// - /// Creates a new low level MQTT client. - /// - /// The logger. - /// A new . ILowLevelMqttClient CreateLowLevelMqttClient(IMqttNetLogger logger); - /// - /// Creates a new low level MQTT client. - /// - /// The client adapter factory. - /// A new . ILowLevelMqttClient CreateLowLevelMqttClient(IMqttClientAdapterFactory clientAdapterFactory); - /// - /// Creates a new low level MQTT client. - /// - /// The logger. - /// The client adapter factory. - /// A new . ILowLevelMqttClient CreateLowLevelMqttClient(IMqttNetLogger logger, IMqttClientAdapterFactory clientAdapterFactory); - /// - /// Creates a new MQTT client. - /// - /// A new . IMqttClient CreateMqttClient(); - /// - /// Creates a new MQTT client. - /// - /// The logger. - /// A new . IMqttClient CreateMqttClient(IMqttNetLogger logger); - /// - /// Creates a new MQTT client. - /// - /// The adapter factory. - /// A new . IMqttClient CreateMqttClient(IMqttClientAdapterFactory adapterFactory); - /// - /// Creates a new MQTT client. - /// - /// The logger. - /// The adapter factory. - /// A new . IMqttClient CreateMqttClient(IMqttNetLogger logger, IMqttClientAdapterFactory adapterFactory); } } \ No newline at end of file diff --git a/Source/MQTTnet/Client/Options/IMqttClientOptions.cs b/Source/MQTTnet/Client/Options/IMqttClientOptions.cs index 642a8728..e159d998 100644 --- a/Source/MQTTnet/Client/Options/IMqttClientOptions.cs +++ b/Source/MQTTnet/Client/Options/IMqttClientOptions.cs @@ -24,29 +24,14 @@ namespace MQTTnet.Client.Options /// bool CleanSession { get; } - /// - /// Gets the credentials. - /// IMqttClientCredentials Credentials { get; } - /// - /// Gets the extended authentication exchange handler. - /// IMqttExtendedAuthenticationExchangeHandler ExtendedAuthenticationExchangeHandler { get; } - /// - /// Gets the protocol version. - /// MqttProtocolVersion ProtocolVersion { get; } - /// - /// Gets the channel options. - /// IMqttClientChannelOptions ChannelOptions { get; } - /// - /// Gets the timeout the communication uses. - /// TimeSpan CommunicationTimeout { get; } /// @@ -82,9 +67,6 @@ namespace MQTTnet.Client.Options /// byte[] AuthenticationData { get; } - /// - /// Gets the maximum packet size. - /// uint? MaximumPacketSize { get; } /// diff --git a/Source/MQTTnet/Client/Options/MqttClientCertificateValidationCallbackContext.cs b/Source/MQTTnet/Client/Options/MqttClientCertificateValidationCallbackContext.cs index 0a863017..3827f05d 100644 --- a/Source/MQTTnet/Client/Options/MqttClientCertificateValidationCallbackContext.cs +++ b/Source/MQTTnet/Client/Options/MqttClientCertificateValidationCallbackContext.cs @@ -5,24 +5,12 @@ namespace MQTTnet.Client.Options { public class MqttClientCertificateValidationCallbackContext { - /// - /// Gets or sets the certificate. - /// public X509Certificate Certificate { get; set; } - /// - /// Gets or sets the certificate chain. - /// public X509Chain Chain { get; set; } - /// - /// Gets or sets the SSL policy errors. - /// public SslPolicyErrors SslPolicyErrors { get; set; } - /// - /// Gets or sets the client options. - /// public IMqttClientChannelOptions ClientOptions { get; set; } } } diff --git a/Source/MQTTnet/Client/Options/MqttClientOptions.cs b/Source/MQTTnet/Client/Options/MqttClientOptions.cs index e150e496..6332a03b 100644 --- a/Source/MQTTnet/Client/Options/MqttClientOptions.cs +++ b/Source/MQTTnet/Client/Options/MqttClientOptions.cs @@ -24,29 +24,14 @@ namespace MQTTnet.Client.Options /// public bool CleanSession { get; set; } = true; - /// - /// Gets or sets the credentials. - /// public IMqttClientCredentials Credentials { get; set; } - /// - /// Gets or sets the extended authentication exchange handler. - /// public IMqttExtendedAuthenticationExchangeHandler ExtendedAuthenticationExchangeHandler { get; set; } - /// - /// Gets or sets the protocol version. - /// public MqttProtocolVersion ProtocolVersion { get; set; } = MqttProtocolVersion.V311; - /// - /// Gets or sets the channel options. - /// public IMqttClientChannelOptions ChannelOptions { get; set; } - /// - /// Gets or sets the timeout the communication uses. - /// public TimeSpan CommunicationTimeout { get; set; } = TimeSpan.FromSeconds(10); /// @@ -82,9 +67,6 @@ namespace MQTTnet.Client.Options /// public byte[] AuthenticationData { get; set; } - /// - /// Gets or sets the maximum packet size. - /// public uint? MaximumPacketSize { get; set; } /// diff --git a/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs b/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs index 402f28a1..68d1aa3f 100644 --- a/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs +++ b/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs @@ -17,11 +17,6 @@ namespace MQTTnet.Client.Options MqttClientOptionsBuilderTlsParameters _tlsParameters; MqttClientWebSocketProxyOptions _proxyOptions; - /// - /// Adds the protocol version to the MQTT client options. - /// - /// The protocol version. - /// A new instance of the class. public MqttClientOptionsBuilder WithProtocolVersion(MqttProtocolVersion value) { if (value == MqttProtocolVersion.Unknown) @@ -33,88 +28,47 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds the communication timeout to the MQTT client options. - /// - /// The timeout. - /// A new instance of the class. public MqttClientOptionsBuilder WithCommunicationTimeout(TimeSpan value) { _options.CommunicationTimeout = value; return this; } - /// - /// Adds the clean session flag to the MQTT client options. - /// - /// The clean session flag. - /// A new instance of the class. public MqttClientOptionsBuilder WithCleanSession(bool value = true) { _options.CleanSession = value; return this; } - /// - /// Adds the keep alive send interval to the MQTT client options. - /// - /// The keep alive interval. - /// A new instance of the class. [Obsolete("This method is no longer supported. The client will send ping requests just before the keep alive interval is going to elapse. As per MQTT RFC the serve has to wait 1.5 times the interval so we don't need this anymore.")] public MqttClientOptionsBuilder WithKeepAliveSendInterval(TimeSpan value) { return this; } - /// - /// Adds no keep alive period to the MQTT client options. - /// - /// A new instance of the class. public MqttClientOptionsBuilder WithNoKeepAlive() { return WithKeepAlivePeriod(TimeSpan.Zero); } - /// - /// Adds the keep alive period to the MQTT client options. - /// - /// The keep alive period. - /// A new instance of the class. public MqttClientOptionsBuilder WithKeepAlivePeriod(TimeSpan value) { _options.KeepAlivePeriod = value; return this; } - /// - /// Adds the client identifier to the MQTT client options. - /// - /// The client identifier. - /// A new instance of the class. public MqttClientOptionsBuilder WithClientId(string value) { _options.ClientId = value; return this; } - /// - /// Adds the will message to the MQTT client options. - /// - /// The will message. - /// A new instance of the class. public MqttClientOptionsBuilder WithWillMessage(MqttApplicationMessage value) { _options.WillMessage = value; return this; } - /// - /// Adds the authentication to the MQTT client options. - /// Hint: MQTT 5 feature only. - /// - /// The authentication method. - /// The data. - /// A new instance of the class. public MqttClientOptionsBuilder WithAuthentication(string method, byte[] data) { _options.AuthenticationMethod = method; @@ -122,92 +76,48 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds the will delay interval to the MQTT client options. - /// - /// The will delay interval. - /// A new instance of the class. public MqttClientOptionsBuilder WithWillDelayInterval(uint? willDelayInterval) { _options.WillDelayInterval = willDelayInterval; return this; } - /// - /// Adds the topic alias maximum to the MQTT client options. - /// - /// The topic alias maximum. - /// A new instance of the class. public MqttClientOptionsBuilder WithTopicAliasMaximum(ushort? topicAliasMaximum) { _options.TopicAliasMaximum = topicAliasMaximum; return this; } - /// - /// Adds the maximum packet size to the MQTT client options. - /// - /// The maximum packet size. - /// A new instance of the class. public MqttClientOptionsBuilder WithMaximumPacketSize(uint? maximumPacketSize) { _options.MaximumPacketSize = maximumPacketSize; return this; } - /// - /// Adds the receive maximum to the MQTT client options. - /// - /// The receive maximum. - /// A new instance of the class. public MqttClientOptionsBuilder WithReceiveMaximum(ushort? receiveMaximum) { _options.ReceiveMaximum = receiveMaximum; return this; } - /// - /// Adds the request problem information to the MQTT client options. - /// Hint: MQTT 5 feature only. - /// - /// The request problem information. - /// A new instance of the class. public MqttClientOptionsBuilder WithRequestProblemInformation(bool? requestProblemInformation = true) { _options.RequestProblemInformation = requestProblemInformation; return this; } - /// - /// Adds the request response information to the MQTT client options. - /// Hint: MQTT 5 feature only. - /// - /// The request response information. - /// A new instance of the class. public MqttClientOptionsBuilder WithRequestResponseInformation(bool? requestResponseInformation = true) { _options.RequestResponseInformation = requestResponseInformation; return this; } - /// - /// Adds the session expiry interval to the MQTT client options. - /// - /// The session expiry interval. - /// A new instance of the class. public MqttClientOptionsBuilder WithSessionExpiryInterval(uint? sessionExpiryInterval) { _options.SessionExpiryInterval = sessionExpiryInterval; return this; } - /// - /// Adds the user property to the MQTT client options. - /// Hint: MQTT 5 feature only. - /// - /// The user property name. - /// The user property value. - /// A new instance of the class. public MqttClientOptionsBuilder WithUserProperty(string name, string value) { if (name is null) throw new ArgumentNullException(nameof(name)); @@ -222,12 +132,6 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds the credentials to the MQTT client options. - /// - /// The user name. - /// The password. - /// A new instance of the class. public MqttClientOptionsBuilder WithCredentials(string username, string password = null) { byte[] passwordBuffer = null; @@ -240,12 +144,6 @@ namespace MQTTnet.Client.Options return WithCredentials(username, passwordBuffer); } - /// - /// Adds the credentials to the MQTT client options. - /// - /// The user name. - /// The password. - /// A new instance of the class. public MqttClientOptionsBuilder WithCredentials(string username, byte[] password = null) { _options.Credentials = new MqttClientCredentials @@ -257,11 +155,6 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds the credentials to the MQTT client options. - /// - /// The credentials. - /// A new instance of the class. public MqttClientOptionsBuilder WithCredentials(IMqttClientCredentials credentials) { _options.Credentials = credentials; @@ -269,23 +162,12 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds a extended authentication exchange handler to the MQTT client options. - /// - /// The handler. - /// A new instance of the class. public MqttClientOptionsBuilder WithExtendedAuthenticationExchangeHandler(IMqttExtendedAuthenticationExchangeHandler handler) { _options.ExtendedAuthenticationExchangeHandler = handler; return this; } - /// - /// Adds a TCP server connection to the MQTT client options. - /// - /// The server. - /// The port. - /// A new instance of the class. public MqttClientOptionsBuilder WithTcpServer(string server, int? port = null) { _tcpOptions = new MqttClientTcpOptions @@ -297,11 +179,6 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds a TCP server connection to the MQTT client options. - /// - /// The options builder. - /// A new instance of the class. // TODO: Consider creating _MqttClientTcpOptionsBuilder_ as overload. public MqttClientOptionsBuilder WithTcpServer(Action optionsBuilder) { @@ -313,16 +190,6 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds a proxy connection to the MQTT client options. - /// - /// The address. - /// The user name. - /// The password. - /// The domain. - /// The bypass on local flag. - /// The bypass list. - /// A new instance of the class. public MqttClientOptionsBuilder WithProxy(string address, string username = null, string password = null, string domain = null, bool bypassOnLocal = false, string[] bypassList = null) { _proxyOptions = new MqttClientWebSocketProxyOptions @@ -338,11 +205,6 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds a proxy connection to the MQTT client options. - /// - /// The options builder. - /// A new instance of the class. public MqttClientOptionsBuilder WithProxy(Action optionsBuilder) { if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder)); @@ -352,12 +214,6 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds a web socket server to the MQTT client options. - /// - /// The uri. - /// The parameters. - /// A new instance of the class. public MqttClientOptionsBuilder WithWebSocketServer(string uri, MqttClientOptionsBuilderWebSocketParameters parameters = null) { _webSocketOptions = new MqttClientWebSocketOptions @@ -370,11 +226,6 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds a web socket server to the MQTT client options. - /// - /// The options builder. - /// A new instance of the class. public MqttClientOptionsBuilder WithWebSocketServer(Action optionsBuilder) { if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder)); @@ -385,31 +236,17 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Adds TLS to the MQTT client options. - /// - /// The parameters. - /// A new instance of the class. public MqttClientOptionsBuilder WithTls(MqttClientOptionsBuilderTlsParameters parameters) { _tlsParameters = parameters; return this; } - /// - /// Adds TLS to the MQTT client options. - /// - /// A new instance of the class. public MqttClientOptionsBuilder WithTls() { return WithTls(new MqttClientOptionsBuilderTlsParameters { UseTls = true }); } - /// - /// Adds TLS to the MQTT client options. - /// - /// The options builder. - /// A new instance of the class. public MqttClientOptionsBuilder WithTls(Action optionsBuilder) { if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder)); @@ -419,10 +256,6 @@ namespace MQTTnet.Client.Options return this; } - /// - /// Builds the MQTT client options. - /// - /// The . public IMqttClientOptions Build() { if (_tcpOptions == null && _webSocketOptions == null) diff --git a/Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs b/Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs index 0a51c989..429f130a 100644 --- a/Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs +++ b/Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs @@ -6,9 +6,6 @@ namespace MQTTnet.Client.Publishing { public class MqttClientPublishResult { - /// - /// Gets or sets the packet identifier. - /// public ushort? PacketIdentifier { get; set; } /// diff --git a/Source/MQTTnet/Client/Receiving/IMqttApplicationMessageReceivedHandler.cs b/Source/MQTTnet/Client/Receiving/IMqttApplicationMessageReceivedHandler.cs index 199adba6..3ea73175 100644 --- a/Source/MQTTnet/Client/Receiving/IMqttApplicationMessageReceivedHandler.cs +++ b/Source/MQTTnet/Client/Receiving/IMqttApplicationMessageReceivedHandler.cs @@ -4,11 +4,6 @@ namespace MQTTnet.Client.Receiving { public interface IMqttApplicationMessageReceivedHandler { - /// - /// Handles the application message received event. - /// - /// The event args. - /// A representing any asynchronous operation. Task HandleApplicationMessageReceivedAsync(MqttApplicationMessageReceivedEventArgs eventArgs); } } diff --git a/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptionsBuilder.cs b/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptionsBuilder.cs index 96e6c5d1..14d2ad6e 100644 --- a/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptionsBuilder.cs +++ b/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptionsBuilder.cs @@ -31,26 +31,12 @@ namespace MQTTnet.Client.Subscribing return this; } - /// - /// Adds the subscription identifier to the subscribe options. - /// - /// The subscription identifier. - /// A new instance of the class. public MqttClientSubscribeOptionsBuilder WithSubscriptionIdentifier(uint? subscriptionIdentifier) { _subscribeOptions.SubscriptionIdentifier = subscriptionIdentifier; return this; } - /// - /// Adds a topic filter to the subscribe options. - /// - /// The topic. - /// The quality of service level. - /// A value indicating whether to not send messages originating on this client (noLocal) or not. - /// A value indicating whether messages are retained as published or not. - /// The retain handling. - /// A new instance of the class. public MqttClientSubscribeOptionsBuilder WithTopicFilter( string topic, MqttQualityOfServiceLevel qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce, @@ -68,11 +54,6 @@ namespace MQTTnet.Client.Subscribing }); } - /// - /// Adds the topic filter to the subscribe options. - /// - /// The topic filter builder. - /// A new instance of the class. public MqttClientSubscribeOptionsBuilder WithTopicFilter(Action topicFilterBuilder) { if (topicFilterBuilder == null) throw new ArgumentNullException(nameof(topicFilterBuilder)); @@ -83,11 +64,6 @@ namespace MQTTnet.Client.Subscribing return WithTopicFilter(internalTopicFilterBuilder); } - /// - /// Adds the topic filter to the subscribe options. - /// - /// The topic filter builder. - /// A new instance of the class. public MqttClientSubscribeOptionsBuilder WithTopicFilter(MqttTopicFilterBuilder topicFilterBuilder) { if (topicFilterBuilder == null) throw new ArgumentNullException(nameof(topicFilterBuilder)); @@ -95,11 +71,6 @@ namespace MQTTnet.Client.Subscribing return WithTopicFilter(topicFilterBuilder.Build()); } - /// - /// Adds the topic filter to the subscribe options. - /// - /// The topic filter. - /// A new instance of the class. public MqttClientSubscribeOptionsBuilder WithTopicFilter(MqttTopicFilter topicFilter) { if (topicFilter == null) throw new ArgumentNullException(nameof(topicFilter)); @@ -114,10 +85,6 @@ namespace MQTTnet.Client.Subscribing return this; } - /// - /// Builds the subscription options. - /// - /// A new instance of the class. public MqttClientSubscribeOptions Build() { return _subscribeOptions; diff --git a/Source/MQTTnet/Client/Unsubscribing/MqttClientUnsubscribeOptionsBuilder.cs b/Source/MQTTnet/Client/Unsubscribing/MqttClientUnsubscribeOptionsBuilder.cs index 56a1997e..a7f022e1 100644 --- a/Source/MQTTnet/Client/Unsubscribing/MqttClientUnsubscribeOptionsBuilder.cs +++ b/Source/MQTTnet/Client/Unsubscribing/MqttClientUnsubscribeOptionsBuilder.cs @@ -43,11 +43,6 @@ namespace MQTTnet.Client.Unsubscribing return this; } - /// - /// Adds the topic filter to the unsubscribe options. - /// - /// The topic. - /// A new instance of the class. public MqttClientUnsubscribeOptionsBuilder WithTopicFilter(string topic) { if (topic is null) throw new ArgumentNullException(nameof(topic)); @@ -62,11 +57,6 @@ namespace MQTTnet.Client.Unsubscribing return this; } - /// - /// Adds the topic filter to the unsubscribe options. - /// - /// The topic filter. - /// A new instance of the class. public MqttClientUnsubscribeOptionsBuilder WithTopicFilter(MqttTopicFilter topicFilter) { if (topicFilter is null) throw new ArgumentNullException(nameof(topicFilter)); @@ -74,10 +64,6 @@ namespace MQTTnet.Client.Unsubscribing return WithTopicFilter(topicFilter.Topic); } - /// - /// Builds the unsubscription options. - /// - /// A new instance of the class. public MqttClientUnsubscribeOptions Build() { return _unsubscribeOptions;