SubscriptionOptions Class |
Subscribe options, primarily defined to allow for message bridge applications.
These include an option to not send messages originating on this client, and options for handling retained messages on subscribe.
Inheritance HierarchySystem.DynamicDynamicObject
NotifyPropertyChangedBase
SimpleCustomTypeDescriptor
GlobalizedProperties
Demo3D.CommonBindableBase
Demo3D.HLE.Comms.MQTTSubscriptionOptions
NotifyPropertyChangedBase
SimpleCustomTypeDescriptor
GlobalizedProperties
Demo3D.CommonBindableBase
Demo3D.HLE.Comms.MQTTSubscriptionOptions
Namespace: Demo3D.HLE.Comms.MQTT
Assembly: Demo3D.HLE (in Demo3D.HLE.dll) Version: 18.03.00
SyntaxC#
[TypeConverterAttribute(typeof(ExpandableObjectConverter))] public sealed class SubscriptionOptions : BindableBase
The SubscriptionOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SubscriptionOptions |
Construct parameters with default values.
|
Properties| Name | Description | |
|---|---|---|
 | NoLocal |
No local option. If the value is 1, messages MUST NOT be forwarded to a connection with a client identifier equal to the identifier of the publishing connection.
|
| QoS |
Maximum quality of service option. The maximum level at which the server can send messages to the client.
|
| RetainAsPublished |
Retain as published option. If true, messages forwarded using this subscription keep the retain flag they were published with.
If 0, messages forwarded using this subscription have the retain flag set to 0.
Retained messages sent when the subscription is established have the retain flag set to 1.
|
| RetainHandling |
Retain handling option. This specifies whether retained messages are sent when the subscription is established.
This does not affect the sending of retained messages at any point after the subscribe. If there are no retained
messages matching the Topic Filter, all of these values act the same. The values are:
0 = Send retained messages at the time of the subscribe. 1 = Send retained messages at subscribe only if the subscription does not currently exist. 2 = Do not send retained messages at the time of the subscribe. |
Methods| Name | Description | |
|---|---|---|
| RaisePropertiesChanged |
Raise an PropertyChanged event for each value.
(Inherited from BindableBase.) |
| RaisePropertyChanged(PropertyChangedEventArgs) |
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.) |
| RaisePropertyChanged(String) |
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.) |
| ToString | (Overrides SimpleCustomTypeDescriptor.ToString.) |
See Also