U3D_TobaccoWarehouseISMDTSystem/Packages/MQTTnet.Extensions.External.RxMQTT.Client.4.3.19/lib/net6.0/MQTTnet.Extensions.External.RxMQTT.Client.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MQTTnet.Extensions.External.RxMQTT.Client</name>
    </assembly>
    <members>
        <member name="T:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient">
            <summary>
            A rx mqtt client based on a <see cref="T:MQTTnet.Extensions.ManagedClient.ManagedMqttClient"/>.
            </summary>
            <remarks>
            Use the <see cref="M:MQTTnet.Extensions.External.RxMQTT.Client.MqttFactoryExtensions.CreateRxMqttClient(MQTTnet.MqttFactory)"/> or
            <see cref="M:MQTTnet.Extensions.External.RxMQTT.Client.MqttFactoryExtensions.CreateRxMqttClient(MQTTnet.MqttFactory,MQTTnet.Diagnostics.IMqttNetLogger)"/>
            factory methods to crate the client.
            </remarks>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.Connected">
            <summary>
            Observer for the connection state of the client.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.ConnectedEvent">
            <summary>
            Observer for the connected event.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.ConnectingFailedEvent">
            <summary>
            Observer for the connection failed event.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.DisconnectedEvent">
            <summary>
            Observer for the disconnected event.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.InternalClient">
            <summary>
            Gets the internally used MQTT client.
            </summary>
            <remarks>
            This property should be used with caution because manipulating the internal client might break the rx client.
            </remarks>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.IsConnected">
            <summary>
            The connection state of the client.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.IsStarted">
            <summary>
            The started state of the client.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.Options">
            <summary>
            The options set for the client.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.PendingApplicationMessagesCount">
            <summary>
            The amount of pending messages.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.SynchronizingSubscriptionsFailedEvent">
            <summary>
            Observer for events when subscribing failed.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.ApplicationMessageProcessedEvent">
            <summary>
            Observer for events when message was processed.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.ApplicationMessageSkippedEvent">
            <summary>
            Observer for events when message was skipped.
            </summary>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.Connect(System.String)">
            <summary>
            Connect to a subscription to the <paramref name="topic"/>.
            </summary>
            <param name="topic">The topic to subscribe.</param>
            <returns>A observer for the messages on the <paramref name="topic"/>.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.PingAsync(System.Threading.CancellationToken)">
            <summary>
            Ping the server.
            </summary>
            <param name="cancellationToken">Token to interrupt the request.</param>
            <returns>The ping task.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.PublishAsync(MQTTnet.Extensions.ManagedClient.ManagedMqttApplicationMessage)">
            <summary>
            Publish a message.
            </summary>
            <param name="applicationMessage">The message to publish.</param>
            <returns>The publish task.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.PublishAsync(MQTTnet.MqttApplicationMessage)">
            <summary>
            Publish a message.
            </summary>
            <param name="applicationMessage">The message to publish.</param>
            <returns>The publish task.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.StartAsync(MQTTnet.Extensions.ManagedClient.ManagedMqttClientOptions)">
            <summary>
            Start the client whit the <paramref name="options"/>.
            </summary>
            <param name="options">The options for the client.</param>
            <returns>The start task.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient.StopAsync">
            <summary>
            Stops the client.
            </summary>
            <returns>The stop task.</returns>
        </member>
        <member name="T:MQTTnet.Extensions.External.RxMQTT.Client.MessageTransform`1">
            <summary>
            A helper to transform the message to a new type <typeparamref name="T"/>.
            </summary>
            <typeparam name="T">The transformed type.</typeparam>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.MessageTransform`1.#ctor(System.IObservable{MQTTnet.MqttApplicationMessage},System.Func{System.Byte[],`0},System.Boolean)">
            <summary>
            Crate a helper to transform the message to a new type <typeparamref name="T"/>.
            </summary>
            <param name="source">The source message observable.</param>
            <param name="transformFunc">The transform function.</param>
            <param name="skipOnError">A flag to indicate to skip transform errors.</param>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.MessageTransform`1.Run">
            <summary>
            Run the transform observer.
            </summary>
            <returns>The transformed observer.</returns>
        </member>
        <member name="T:MQTTnet.Extensions.External.RxMQTT.Client.MqttFactoryExtensions">
            <summary>
            Extension to <see cref="T:MQTTnet.MqttFactory"/> to crate a <see cref="T:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient"/>.
            </summary>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.MqttFactoryExtensions.CreateRxMqttClient(MQTTnet.MqttFactory)">
            <summary>
            Crate a <see cref="T:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient"/> from the factory.
            </summary>
            <param name="factory">The factory to use.</param>
            <returns>The <see cref="T:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient"/>.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.MqttFactoryExtensions.CreateRxMqttClient(MQTTnet.MqttFactory,MQTTnet.Diagnostics.IMqttNetLogger)">
            <summary>
            Crate a <see cref="T:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient"/> from the factory.
            </summary>
            <param name="factory">The factory to use.</param>
            <param name="logger">The mqtt net logger to use.</param>
            <returns>The <see cref="T:MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient"/>.</returns>
        </member>
        <member name="T:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient">
            <summary>
            A mqtt client using <see cref="N:System.Reactive" /> for subscribing to topics.
            </summary>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.#ctor(MQTTnet.Extensions.ManagedClient.IManagedMqttClient,MQTTnet.Diagnostics.IMqttNetLogger)">
            <summary>
            Create a rx mqtt client based on a <see cref="T:MQTTnet.Extensions.ManagedClient.ManagedMqttClient" />.
            </summary>
            <param name="managedMqttClient">The manged mqtt client.</param>
            <param name="logger">The mqtt net logger.</param>
            <remarks>
            Use the
            <see cref="M:MQTTnet.Extensions.External.RxMQTT.Client.MqttFactoryExtensions.CreateRxMqttClient(MQTTnet.MqttFactory)" />
            or
            <see cref="M:MQTTnet.Extensions.External.RxMQTT.Client.MqttFactoryExtensions.CreateRxMqttClient(MQTTnet.MqttFactory,MQTTnet.Diagnostics.IMqttNetLogger)" />
            factory methods to crate the client.
            </remarks>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.ApplicationMessageProcessedEvent">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.ApplicationMessageSkippedEvent">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.Connected">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.ConnectedEvent">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.ConnectingFailedEvent">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.DisconnectedEvent">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.InternalClient">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.IsConnected">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.IsStarted">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.Options">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.PendingApplicationMessagesCount">
            <inheritdoc />
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.SynchronizingSubscriptionsFailedEvent">
            <inheritdoc />
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.Connect(System.String)">
            <inheritdoc />
            <exception cref="T:System.ArgumentException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.PingAsync(System.Threading.CancellationToken)">
            <inheritdoc />
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.PublishAsync(MQTTnet.Extensions.ManagedClient.ManagedMqttApplicationMessage)">
            <inheritdoc />
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.PublishAsync(MQTTnet.MqttApplicationMessage)">
            <inheritdoc />
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.StartAsync(MQTTnet.Extensions.ManagedClient.ManagedMqttClientOptions)">
            <inheritdoc />
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.StopAsync">
            <inheritdoc />
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClient.Dispose(System.Boolean)">
            <inheritdoc />
        </member>
        <member name="T:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions">
            <summary>
            Extensions for rx mqtt client.
            </summary>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.FilterQoS(System.IObservable{MQTTnet.MqttApplicationMessage},MQTTnet.Protocol.MqttQualityOfServiceLevel)">
            <summary>
            Filter the stream by a <see cref="T:MQTTnet.Protocol.MqttQualityOfServiceLevel"/>.
            </summary>
            <param name="source">The source observable.</param>
            <param name="mqttQualityOfServiceLevel">The level to filter for.</param>
            <returns>The filtered source.</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.FilterQoS(System.IObservable{MQTTnet.Client.MqttApplicationMessageReceivedEventArgs},MQTTnet.Protocol.MqttQualityOfServiceLevel)">
            <summary>
            Filter the stream by a <see cref="T:MQTTnet.Protocol.MqttQualityOfServiceLevel"/>.
            </summary>
            <param name="source">The source observable.</param>
            <param name="mqttQualityOfServiceLevel">The level to filter for.</param>
            <returns>The filtered source.</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.FilterTopic(System.IObservable{MQTTnet.Client.MqttApplicationMessageReceivedEventArgs},System.String)">
            <summary>
            Filter the stream by a topic.
            </summary>
            <param name="source">The source observable.</param>
            <param name="filter">The level to filter for.</param>
            <returns>The filtered source.</returns>
            <remarks>Wildcards '#' and '+' are allowed.</remarks>
            <exception cref="T:System.ArgumentNullException"></exception>
            <exception cref="T:System.ArgumentException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.FilterTopic(System.IObservable{MQTTnet.MqttApplicationMessage},System.String)">
            <summary>
            Filter the stream by a topic.
            </summary>
            <param name="source">The source observable.</param>
            <param name="filter">The level to filter for.</param>
            <returns>The filtered source.</returns>
            <remarks>Wildcards '#' and '+' are allowed.</remarks>
            <exception cref="T:System.ArgumentNullException"></exception>
            <exception cref="T:System.ArgumentException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.SelectMessage(System.IObservable{MQTTnet.Client.MqttApplicationMessageReceivedEventArgs})">
            <summary>
            Select the message from the event arguments.
            </summary>
            <param name="source">The source observable.</param>
            <returns>The selected messages observable.</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.SelectPayload(System.IObservable{MQTTnet.Client.MqttApplicationMessageReceivedEventArgs},System.Boolean,System.String)">
            <summary>
            Select the payload as <see cref="T:System.String"/> from the event arguments.
            </summary>
            <param name="source">The source observable.</param>
            <param name="skipOnError">Messages that can not be transformed are skipped.</param>
            <param name="defaultOnNull">The default string when payload is null.</param>
            <returns>The selected payload observable.</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.SelectPayload``1(System.IObservable{MQTTnet.Client.MqttApplicationMessageReceivedEventArgs},System.Func{System.Byte[],``0},System.Boolean)">
            <summary>
            Select the payload as <typeparamref name="T"/> from the event arguments.
            </summary>
            <param name="source">The source observable.</param>
            <param name="getPayloadFunc">The function to geht the payload form the <see cref="T:System.Byte"/> array.</param>
            <param name="skipOnError">Messages that can not be transformed are skipped.</param>
            <returns>The selected payload observable.</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.SelectPayload(System.IObservable{MQTTnet.MqttApplicationMessage},System.Boolean,System.String)">
            <summary>
            Select the payload as <see cref="T:System.String"/> from the message.
            </summary>
            <param name="source">The source observable.</param>
            <param name="skipOnError">Messages that can not be transformed are skipped.</param>
            <param name="defaultOnNull">The default string when payload is null.</param>
            <returns>The selected payload observable.</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.SelectPayload``1(System.IObservable{MQTTnet.MqttApplicationMessage},System.Func{System.Byte[],``0},System.Boolean)">
            <summary>
            Select the payload as <typeparamref name="T"/> from the message.
            </summary>
            <param name="source">The source observable.</param>
            <param name="getPayloadFunc">The function to geht the payload form the <see cref="T:System.Byte"/> array.</param>
            <param name="skipOnError">Messages that can not be transformed are skipped.</param>
            <returns>The selected payload observable.</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientExtensions.ToUTF8String(System.Byte[],System.String)">
            <summary>
            Get a UTF8 string form a byte array.
            </summary>
            <param name="byteArray">The byte array.</param>
            <param name="defaultOnNull">The default string if the array is empty.</param>
            <returns></returns>
        </member>
        <member name="T:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishReasonCode">
            <summary>
            Reasons for a rx mqtt publish result.
            </summary>
        </member>
        <member name="F:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishReasonCode.HasSucceeded">
            <summary>
            Message published.
            </summary>
        </member>
        <member name="F:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishReasonCode.ClientNotConnected">
            <summary>
            Message not published, because client was not connected.
            </summary>
        </member>
        <member name="F:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishReasonCode.HasFailed">
            <summary>
            Message not published, because publish has failed.
            </summary>
        </member>
        <member name="F:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishReasonCode.HasSkipped">
            <summary>
            Message not published, because message was skipped due message queue overflow.
            </summary>
        </member>
        <member name="T:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishResult">
            <summary>
            A result for publishing messages form a observable.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishResult.ReasonCode">
            <summary>
            The reason code for the result.
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishResult.MqttApplicationMessage">
            <summary>
            The processed message
            </summary>
        </member>
        <member name="P:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttClientPublishResult.Exception">
            <summary>
            Optional a exception during processing.
            </summary>
        </member>
        <member name="T:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttPublishExtensions">
            <summary>
            Extensions to publish messages from a observer.
            </summary>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttPublishExtensions.Publish(MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient,System.IObservable{MQTTnet.Extensions.ManagedClient.ManagedMqttApplicationMessage})">
            <summary>
            Publish the stream of <see cref="T:MQTTnet.Extensions.ManagedClient.ManagedMqttApplicationMessage"/>s to the server and give a response of the publish result.
            </summary>
            <param name="rxMqttClinet">The client to publish the messages with.</param>
            <param name="observable">The source observable.</param>
            <returns>A observer for the publish results.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttPublishExtensions.Publish(MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient,System.IObservable{MQTTnet.MqttApplicationMessage})">
            <summary>
            Publish the stream of <see cref="T:MQTTnet.MqttApplicationMessage"/>s to the server and give a response of the publish result.
            </summary>
            <param name="rxMqttClinet">The client to publish the messages with.</param>
            <param name="observable">The source observable.</param>
            <returns>A observer for the publish results.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttPublishExtensions.PublishOn(System.IObservable{MQTTnet.MqttApplicationMessage},MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient)">
            <summary>
            Publish the stream of <see cref="T:MQTTnet.MqttApplicationMessage"/>s to the server and give a response of the publish result.
            </summary>
            <param name="observable">The source observable.</param>
            <param name="rxMqttClinet">The client to publish the messages with.</param>
            <returns>A observer for the publish results.</returns>
        </member>
        <member name="M:MQTTnet.Extensions.External.RxMQTT.Client.RxMqttPublishExtensions.PublishOn(System.IObservable{MQTTnet.Extensions.ManagedClient.ManagedMqttApplicationMessage},MQTTnet.Extensions.External.RxMQTT.Client.IRxMqttClient)">
            <summary>
            Publish the stream of <see cref="T:MQTTnet.Extensions.ManagedClient.ManagedMqttApplicationMessage"/>s to the server and give a response of the publish result.
            </summary>
            <param name="observable">The source observable.</param>
            <param name="rxMqttClinet">The client to publish the messages with.</param>
            <returns>A observer for the publish results.</returns>
        </member>
        <member name="T:ReactiveMarbles.ObservableEvents.ObservableGeneratorExtensions">
            <summary>
            Extension methods to generate IObservable for contained events on the class.
            </summary>
        </member>
        <member name="M:ReactiveMarbles.ObservableEvents.ObservableGeneratorExtensions.Events``1(``0)">
            <summary>
            Gets observable wrappers for all the events contained within the class.
            </summary>
            <returns>The events if available.</returns>
        </member>
        <member name="T:ReactiveMarbles.ObservableEvents.GenerateStaticEventObservablesAttribute">
            <summary>
            Generates a IObservable`T` wrapper for the specified type.
            </summary>
        </member>
        <member name="M:ReactiveMarbles.ObservableEvents.GenerateStaticEventObservablesAttribute.#ctor(System.Type)">
            <summary>
            Initializes a new instance of the <see cref="T:ReactiveMarbles.ObservableEvents.GenerateStaticEventObservablesAttribute"/> class.
            </summary>
            <param name="type">The static type to generate event observable wrappers for.</param>
        </member>
        <member name="P:ReactiveMarbles.ObservableEvents.GenerateStaticEventObservablesAttribute.Type">
            <summary>Gets the Type to generate the static event observable wrappers for.</summary>
        </member>
    </members>
</doc>