Class MqttClientAgent

Namespace

Kepware.Api.Model

Assembly

Kepware.Api.dll

Represents an MQTT Client agent in the IoT Gateway.

[Endpoint("/config/v1/project/_iot_gateway/mqtt_clients/{name}", null)]
public class MqttClientAgent : PublishingIotAgent, IEquatable<BaseEntity>, IHaveOwner, IHaveName

Inheritance

object

BaseEntity

DefaultEntity

NamedEntity

IotAgent

PublishingIotAgent

MqttClientAgent

Implements

IEquatable<BaseEntity>

IHaveOwner

IHaveName

Inherited Members

PublishingIotAgent.PublishType

PublishingIotAgent.RateMs

PublishingIotAgent.PublishFormat

PublishingIotAgent.MaxEventsPerPublish

PublishingIotAgent.TransactionTimeoutS

PublishingIotAgent.SendInitialUpdate

PublishingIotAgent.MessageFormat

PublishingIotAgent.StandardTemplate

PublishingIotAgent.ExpansionOfValues

PublishingIotAgent.AdvancedTemplate

IotAgent.IotItems

IotAgent.AgentType

IotAgent.Enabled

IotAgent.IgnoreQualityChanges

IotAgent.ThisAgentTotal

IotAgent.AllAgentsTotal

IotAgent.LicenseLimit

IotAgent.Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

NamedEntity.Name

NamedEntity.AppendHashSources(CustomHashGenerator.HashSourceBuilder)

NamedEntity.GetUpdateDiff(NamedEntity, bool)

DefaultEntity.Owner

BaseEntity.IncludesNestedDynamicProperties

BaseEntity.Hash

BaseEntity.ProjectId

BaseEntity.Description

BaseEntity.TypeName

BaseEntity.DynamicProperties

BaseEntity.Equals(BaseEntity)

BaseEntity.GetDynamicProperty<T>(string)

BaseEntity.SetDynamicProperty<T>(string, T)

BaseEntity.TryGetDynamicProperty<T>(string, out T)

BaseEntity.CalculateHash()

BaseEntity.EnsureDynamicPropertiesNormalized()

BaseEntity.NormalizeNestedProperties()

BaseEntity.ConditionalNonSerialized()

BaseEntity.GetUpdateDiff(DefaultEntity)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

HelperExtentions.Flatten(NamedEntity?)

HelperExtentions.Flatten(NamedEntity?, Type)

Constructors

MqttClientAgent()

Initializes a new instance of the MqttClientAgent class.

MqttClientAgent(string)

Initializes a new instance of the MqttClientAgent class with the specified name.

Properties

ClientCertificate

Gets or sets whether client certificate authentication is enabled.

ClientId

Gets or sets the client ID for broker communication.

EnableLastWill

Gets or sets whether Last Will and Testament is enabled.

EnableWriteTopic

Gets or sets whether write request listening is enabled.

LastWillMessage

Gets or sets the Last Will and Testament message.

LastWillTopic

Gets or sets the Last Will and Testament topic.

Password

Gets or sets the password for broker authentication.

Qos

Gets or sets the MQTT Quality of Service level.

TlsVersion

Gets or sets the TLS version for secure connections.

Topic

Gets or sets the MQTT topic for publishing data.

Url

Gets or sets the MQTT broker URL.

Username

Gets or sets the username for broker authentication.

WriteTopic

Gets or sets the topic for write request subscriptions.