MqttClientExtensions.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. using MQTTnet.Client.Connecting;
  2. using MQTTnet.Client.Disconnecting;
  3. using MQTTnet.Client.ExtendedAuthenticationExchange;
  4. using MQTTnet.Client.Options;
  5. using MQTTnet.Client.Publishing;
  6. using MQTTnet.Client.Receiving;
  7. using MQTTnet.Client.Subscribing;
  8. using MQTTnet.Client.Unsubscribing;
  9. using MQTTnet.Protocol;
  10. using System;
  11. using System.Collections.Generic;
  12. using System.Threading;
  13. using System.Threading.Tasks;
  14. namespace MQTTnet.Client
  15. {
  16. public static class MqttClientExtensions
  17. {
  18. public static IMqttClient UseConnectedHandler(this IMqttClient client, Func<MqttClientConnectedEventArgs, Task> handler)
  19. {
  20. if (client == null) throw new ArgumentNullException(nameof(client));
  21. if (handler == null)
  22. {
  23. return client.UseConnectedHandler((IMqttClientConnectedHandler)null);
  24. }
  25. return client.UseConnectedHandler(new MqttClientConnectedHandlerDelegate(handler));
  26. }
  27. public static IMqttClient UseConnectedHandler(this IMqttClient client, Action<MqttClientConnectedEventArgs> handler)
  28. {
  29. if (client == null) throw new ArgumentNullException(nameof(client));
  30. if (handler == null)
  31. {
  32. return client.UseConnectedHandler((IMqttClientConnectedHandler)null);
  33. }
  34. return client.UseConnectedHandler(new MqttClientConnectedHandlerDelegate(handler));
  35. }
  36. public static IMqttClient UseConnectedHandler(this IMqttClient client, IMqttClientConnectedHandler handler)
  37. {
  38. if (client == null) throw new ArgumentNullException(nameof(client));
  39. client.ConnectedHandler = handler;
  40. return client;
  41. }
  42. public static IMqttClient UseDisconnectedHandler(this IMqttClient client, Func<MqttClientDisconnectedEventArgs, Task> handler)
  43. {
  44. if (client == null) throw new ArgumentNullException(nameof(client));
  45. if (handler == null)
  46. {
  47. return client.UseDisconnectedHandler((IMqttClientDisconnectedHandler)null);
  48. }
  49. return client.UseDisconnectedHandler(new MqttClientDisconnectedHandlerDelegate(handler));
  50. }
  51. public static IMqttClient UseDisconnectedHandler(this IMqttClient client, Action<MqttClientDisconnectedEventArgs> handler)
  52. {
  53. if (client == null) throw new ArgumentNullException(nameof(client));
  54. if (handler == null)
  55. {
  56. return client.UseDisconnectedHandler((IMqttClientDisconnectedHandler)null);
  57. }
  58. return client.UseDisconnectedHandler(new MqttClientDisconnectedHandlerDelegate(handler));
  59. }
  60. public static IMqttClient UseDisconnectedHandler(this IMqttClient client, IMqttClientDisconnectedHandler handler)
  61. {
  62. if (client == null) throw new ArgumentNullException(nameof(client));
  63. client.DisconnectedHandler = handler;
  64. return client;
  65. }
  66. public static IMqttClient UseApplicationMessageReceivedHandler(this IMqttClient client, Func<MqttApplicationMessageReceivedEventArgs, Task> handler)
  67. {
  68. if (client == null) throw new ArgumentNullException(nameof(client));
  69. if (handler == null)
  70. {
  71. return client.UseApplicationMessageReceivedHandler((IMqttApplicationMessageReceivedHandler)null);
  72. }
  73. return client.UseApplicationMessageReceivedHandler(new MqttApplicationMessageReceivedHandlerDelegate(handler));
  74. }
  75. public static IMqttClient UseApplicationMessageReceivedHandler(this IMqttClient client, Action<MqttApplicationMessageReceivedEventArgs> handler)
  76. {
  77. if (client == null) throw new ArgumentNullException(nameof(client));
  78. if (handler == null)
  79. {
  80. return client.UseApplicationMessageReceivedHandler((IMqttApplicationMessageReceivedHandler)null);
  81. }
  82. return client.UseApplicationMessageReceivedHandler(new MqttApplicationMessageReceivedHandlerDelegate(handler));
  83. }
  84. public static IMqttClient UseApplicationMessageReceivedHandler(this IMqttClient client, IMqttApplicationMessageReceivedHandler handler)
  85. {
  86. if (client == null) throw new ArgumentNullException(nameof(client));
  87. client.ApplicationMessageReceivedHandler = handler;
  88. return client;
  89. }
  90. public static Task ReconnectAsync(this IMqttClient client)
  91. {
  92. if (client == null) throw new ArgumentNullException(nameof(client));
  93. if (client.Options == null)
  94. {
  95. throw new InvalidOperationException("_ReconnectAsync_ can be used only if _ConnectAsync_ was called before.");
  96. }
  97. return client.ConnectAsync(client.Options);
  98. }
  99. public static Task DisconnectAsync(this IMqttClient client)
  100. {
  101. if (client == null) throw new ArgumentNullException(nameof(client));
  102. return client.DisconnectAsync(new MqttClientDisconnectOptions());
  103. }
  104. public static Task<MqttClientSubscribeResult> SubscribeAsync(this IMqttClient client, params MqttTopicFilter[] topicFilters)
  105. {
  106. if (client == null) throw new ArgumentNullException(nameof(client));
  107. if (topicFilters == null) throw new ArgumentNullException(nameof(topicFilters));
  108. var options = new MqttClientSubscribeOptions();
  109. options.TopicFilters.AddRange(topicFilters);
  110. return client.SubscribeAsync(options);
  111. }
  112. public static Task<MqttClientSubscribeResult> SubscribeAsync(this IMqttClient client, string topic, MqttQualityOfServiceLevel qualityOfServiceLevel)
  113. {
  114. if (client == null) throw new ArgumentNullException(nameof(client));
  115. if (topic == null) throw new ArgumentNullException(nameof(topic));
  116. return client.SubscribeAsync(new MqttTopicFilterBuilder().WithTopic(topic).WithQualityOfServiceLevel(qualityOfServiceLevel).Build());
  117. }
  118. public static Task<MqttClientSubscribeResult> SubscribeAsync(this IMqttClient client, string topic)
  119. {
  120. if (client == null) throw new ArgumentNullException(nameof(client));
  121. if (topic == null) throw new ArgumentNullException(nameof(topic));
  122. return client.SubscribeAsync(new MqttTopicFilterBuilder().WithTopic(topic).Build());
  123. }
  124. public static Task<MqttClientUnsubscribeResult> UnsubscribeAsync(this IMqttClient client, params string[] topicFilters)
  125. {
  126. if (client == null) throw new ArgumentNullException(nameof(client));
  127. if (topicFilters == null) throw new ArgumentNullException(nameof(topicFilters));
  128. var options = new MqttClientUnsubscribeOptions();
  129. options.TopicFilters.AddRange(topicFilters);
  130. return client.UnsubscribeAsync(options);
  131. }
  132. public static Task<MqttClientAuthenticateResult> ConnectAsync(this IMqttClient client, IMqttClientOptions options)
  133. {
  134. if (client == null) throw new ArgumentNullException(nameof(client));
  135. return client.ConnectAsync(options, CancellationToken.None);
  136. }
  137. public static Task DisconnectAsync(this IMqttClient client, MqttClientDisconnectOptions options)
  138. {
  139. if (client == null) throw new ArgumentNullException(nameof(client));
  140. return client.DisconnectAsync(options, CancellationToken.None);
  141. }
  142. public static Task SendExtendedAuthenticationExchangeDataAsync(this IMqttClient client, MqttExtendedAuthenticationExchangeData data)
  143. {
  144. if (client == null) throw new ArgumentNullException(nameof(client));
  145. return client.SendExtendedAuthenticationExchangeDataAsync(data, CancellationToken.None);
  146. }
  147. public static Task<MqttClientSubscribeResult> SubscribeAsync(this IMqttClient client, MqttClientSubscribeOptions options)
  148. {
  149. if (client == null) throw new ArgumentNullException(nameof(client));
  150. return client.SubscribeAsync(options, CancellationToken.None);
  151. }
  152. public static Task<MqttClientUnsubscribeResult> UnsubscribeAsync(this IMqttClient client, MqttClientUnsubscribeOptions options)
  153. {
  154. if (client == null) throw new ArgumentNullException(nameof(client));
  155. return client.UnsubscribeAsync(options, CancellationToken.None);
  156. }
  157. public static Task<MqttClientPublishResult> PublishAsync(this IMqttClient client, MqttApplicationMessage applicationMessage)
  158. {
  159. if (client == null) throw new ArgumentNullException(nameof(client));
  160. if (applicationMessage == null) throw new ArgumentNullException(nameof(applicationMessage));
  161. return client.PublishAsync(applicationMessage, CancellationToken.None);
  162. }
  163. public static async Task PublishAsync(this IMqttClient client, IEnumerable<MqttApplicationMessage> applicationMessages)
  164. {
  165. if (client == null) throw new ArgumentNullException(nameof(client));
  166. if (applicationMessages == null) throw new ArgumentNullException(nameof(applicationMessages));
  167. foreach (var applicationMessage in applicationMessages)
  168. {
  169. await client.PublishAsync(applicationMessage).ConfigureAwait(false);
  170. }
  171. }
  172. public static Task<MqttClientPublishResult> PublishAsync(this IMqttClient client, string topic)
  173. {
  174. if (client == null) throw new ArgumentNullException(nameof(client));
  175. if (topic == null) throw new ArgumentNullException(nameof(topic));
  176. return client.PublishAsync(new MqttApplicationMessageBuilder()
  177. .WithTopic(topic)
  178. .Build());
  179. }
  180. public static Task<MqttClientPublishResult> PublishAsync(this IMqttClient client, string topic, IEnumerable<byte> payload)
  181. {
  182. if (client == null) throw new ArgumentNullException(nameof(client));
  183. if (topic == null) throw new ArgumentNullException(nameof(topic));
  184. return client.PublishAsync(new MqttApplicationMessageBuilder()
  185. .WithTopic(topic)
  186. .WithPayload(payload)
  187. .Build());
  188. }
  189. public static Task<MqttClientPublishResult> PublishAsync(this IMqttClient client, string topic, string payload)
  190. {
  191. if (client == null) throw new ArgumentNullException(nameof(client));
  192. if (topic == null) throw new ArgumentNullException(nameof(topic));
  193. return client.PublishAsync(new MqttApplicationMessageBuilder()
  194. .WithTopic(topic)
  195. .WithPayload(payload)
  196. .Build());
  197. }
  198. public static Task<MqttClientPublishResult> PublishAsync(this IMqttClient client, string topic, string payload, MqttQualityOfServiceLevel qualityOfServiceLevel)
  199. {
  200. if (client == null) throw new ArgumentNullException(nameof(client));
  201. if (topic == null) throw new ArgumentNullException(nameof(topic));
  202. return client.PublishAsync(new MqttApplicationMessageBuilder()
  203. .WithTopic(topic)
  204. .WithPayload(payload)
  205. .WithQualityOfServiceLevel(qualityOfServiceLevel)
  206. .Build());
  207. }
  208. public static Task<MqttClientPublishResult> PublishAsync(this IMqttClient client, string topic, string payload, MqttQualityOfServiceLevel qualityOfServiceLevel, bool retain)
  209. {
  210. if (client == null) throw new ArgumentNullException(nameof(client));
  211. if (topic == null) throw new ArgumentNullException(nameof(topic));
  212. return client.PublishAsync(new MqttApplicationMessageBuilder()
  213. .WithTopic(topic)
  214. .WithPayload(payload)
  215. .WithQualityOfServiceLevel(qualityOfServiceLevel)
  216. .WithRetainFlag(retain)
  217. .Build());
  218. }
  219. public static Task<MqttClientPublishResult> PublishAsync(this IMqttClient client, string topic, string payload, bool retain)
  220. {
  221. if (client == null) throw new ArgumentNullException(nameof(client));
  222. if (topic == null) throw new ArgumentNullException(nameof(topic));
  223. return client.PublishAsync(new MqttApplicationMessageBuilder()
  224. .WithTopic(topic)
  225. .WithPayload(payload)
  226. .WithRetainFlag(retain)
  227. .Build());
  228. }
  229. }
  230. }