YangWX/MQTTnet
1
0
Fork 0
mirror of https://github.com/dotnet/MQTTnet.git synced 2026-10-18 02:13:00 +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.Extensions.ManagedClient/IManagedMqttClient.cs
-59
View File
@@ -16,95 +16,36 @@ namespace MQTTnet.Extensions.ManagedClient
/// </summary>
IMqttClient InternalClient { get; }
/// <summary>
/// Gets a value indicating whether the client is started or not.
/// </summary>
bool IsStarted { get; }
/// <summary>
/// Gets a value indicating whether the client is connected or not.
/// </summary>
bool IsConnected { get; }
/// <summary>
/// Gets a pending application message count.
/// </summary>
int PendingApplicationMessagesCount { get; }
/// <summary>
/// Gets the MQTT client options.
/// </summary>
IManagedMqttClientOptions Options { get; }
/// <summary>
/// Gets or sets the connected handler.
/// </summary>
IMqttClientConnectedHandler ConnectedHandler { get; set; }
/// <summary>
/// Gets or sets the disconnected handler.
/// </summary>
IMqttClientDisconnectedHandler DisconnectedHandler { get; set; }
/// <summary>
/// Gets or sets the application message process handler.
/// </summary>
IApplicationMessageProcessedHandler ApplicationMessageProcessedHandler { get; set; }
/// <summary>
/// Gets or sets the application message skipped handler.
/// </summary>
IApplicationMessageSkippedHandler ApplicationMessageSkippedHandler { get; set; }
/// <summary>
/// Gets or sets the connecting failed handler.
/// </summary>
IConnectingFailedHandler ConnectingFailedHandler { get; set; }
/// <summary>
/// Gets or sets the synchronizing subscriptions failed handler.
/// </summary>
ISynchronizingSubscriptionsFailedHandler SynchronizingSubscriptionsFailedHandler { get; set; }
/// <summary>
/// Starts the client.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>A <see cref="Task"/> representing any asynchronous operation.</returns>
Task StartAsync(IManagedMqttClientOptions options);
/// <summary>
/// Stops the client.
/// </summary>
/// <returns>A <see cref="Task"/> representing any asynchronous operation.</returns>
Task StopAsync();
/// <summary>
/// Pings the server.
/// </summary>
/// <param name="cancellationToken">A token to cancel the task.</param>
/// <returns>A <see cref="Task"/> representing any asynchronous operation.</returns>
Task PingAsync(CancellationToken cancellationToken);
/// <summary>
/// Subscribes the client.
/// </summary>
/// <param name="topicFilters">The topic filters.</param>
/// <returns>A <see cref="Task"/> representing any asynchronous operation.</returns>
Task SubscribeAsync(IEnumerable<MqttTopicFilter> topicFilters);
/// <summary>
/// Unsubscribes the client.
/// </summary>
/// <param name="topics">The topics.</param>
/// <returns>A <see cref="Task"/> representing any asynchronous operation.</returns>
Task UnsubscribeAsync(IEnumerable<string> topics);
/// <summary>
/// Publishes a message from the client.
/// </summary>
/// <param name="applicationMessages">The application messages.</param>
/// <returns>A <see cref="Task"/> representing any asynchronous operation.</returns>
Task PublishAsync(ManagedMqttApplicationMessage applicationMessages);
}
}