MQTTPublishProperties (STRUCT) ¶ TYPE MQTTPublishProperties : STRUCT Publish properties (MQTT V5) The structure is used for sending and receiving properties. Notice: Some fields are only relevant for the publisher or the subscriber. InOut: Name Type Comment bPayloadFormatIndicator BYTE Payload Format: 0: Binary Data, 1: UTF-8 (relevant for publisher and subscriber) udiMessageExpiryInterval UDINT Expiry interval of the message in seconds (relevant for publisher and subscriber) wsContentType WSTRING MIME style content type of the payload (relevant for publisher and subscriber) wsResponseTopic WSTRING(1024) Some applications or standards might wish to run a Request/Response interaction over MQTT. The Resopnse Topic can be used for this purpose. (relevant for publisher and subscriber) udiCorrelationDataSize UDINT Size of the correlation data buffer |paCorrelationData| (relevant for publisher and subscriber) paCorrelationData POINTER TO BYTE Pointer to correlation data buffer. The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received. (relevant for publisher and subscriber) udiSubscriptionIdentifier UDINT The subscription identifier of the last received message (see output of the subscriber function block). The subscription identifier can be set via MQTTSubscribeProperties.udiSubscriptionIdentifier. The identifier has no effect for the publisher function block. (relevant for the subscriber) uiTopicAlias UINT A Topic Alias is an integer value that is used to identify the Topic instead of using the Topic Name. If a Topic Alias mapping has been set at the receiver (the broker), a sender can send a PUBLISH packet that contains that Topic Alias and a zero length Topic Name. The receiver (the broker) then treats the incoming PUBLISH as if it had contained the Topic Name of the Topic Alias. The Topic Alias has no effect for the subscriber function block and is not transferd from the broker to the subscriber. (relevant for the publisher) userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair User defined properties (relevant for publisher and subscriber)
MQTTStringPair (STRUCT) ¶ TYPE MQTTStringPair : STRUCT Key-value pair for user properties (MQTT V5) InOut: Name Type Comment wsKey WSTRING(MQTTParam.g_udiMaxUserPropertyValueLength) The key wsValue WSTRING(MQTTParam.g_udiMaxUserPropertyValueLength) The value
MQTTSubscribeProperties (STRUCT) ¶ TYPE MQTTSubscribeProperties : STRUCT Subscribe properties (MQTT V5) InOut: Name Type Comment udiSubscriptionIdentifier UDINT The subscription identifier will be returned on the message when it is delivered. This allows the Client to determine which subscription or subscriptions caused the message to be delivered. Setting the identifier accelerates the filtering of the telegrams in the subscriber function block. udiCorrelationDataSize UDINT Size of the correlation data receive buffer |paCorrelationData| paCorrelationData POINTER TO BYTE Pointer to correlation data reveive buffer. The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received. userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair User defined properties xNoLocalOption BOOL No Local option If the value is TRUE, Application Messages MUST NOT be forwarded to a connection with a ClientID equal to the ClientID of the publishing connection xRetainAsPublished BOOL Retain As Published option If TRUE, Application Messages forwarded using this subscription keep the RETAIN flag they were published with. eRetainHandling MQTT_RETAIN_HANDLING This option specifies 2135 whether retained messages are sent when the subscription is established.
MQTTWillProperties (STRUCT) ¶ TYPE MQTTWillProperties : STRUCT Will properties (MQTT V5) InOut: Name Type Comment bPayloadFormatIndicator BYTE Payload Format: 0: Binary Data, 1: UTF-8 udiMessageExpiryInterval UDINT Expiry interval of the message in seconds wsContentType WSTRING MIME style content type of the payload wsResponseTopic WSTRING Some applications or standards might wish to run a Request/Response interaction over MQTT. The Resopnse Topic can be used for this purpose. udiCorrelationDataSize UDINT Size of the correlation data buffer |paCorrelationData| paCorrelationData POINTER TO BYTE Pointer to correlation data buffer. The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received. udiWillDelayInterval UDINT The Server delays publishing the Client’s Will Message until the Will Delay Interval (in seconds) has passed or the Session ends, whichever happens first. userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair User defined properties
OPC UA PubSub SL ¶ Aliases Function Blocks AsyncProperty (Alias) IPAddressSet (Alias) IPv4Address (Alias) ResolveHostname (Alias) IPADDRESS (Alias) Interfaces IAsyncProperty (Alias) IIPAddress (Alias) IIPAddressSet (Alias) ITSNContext (Alias) Constants IEC_TYPES (GVL) UDP (GVL) Enums BIT_OFFSET (Alias) BIT_SIZE (Enum) DiagnosticsClassification (Enum) DiagnosticsLevel (Enum) ERROR (Enum) STATE (Enum) Function Blocks Configuration (FunctionBlock) SetInitialValue (Method) Connection (FunctionBlock) SetInitialValue (Method) DataSet (FunctionBlock) PrepareValues (Method) SetInitialValue (Method) Diagnostics Base Diagnostics (Folder) DiagnosticsCounter (FunctionBlock) ConnectionDiagnostics (FunctionBlock) ReaderDiagnostics (FunctionBlock) ReaderGroupDiagnostics (FunctionBlock) RootDiagnostics (FunctionBlock) WriterDiagnostics (FunctionBlock) WriterGroupDiagnostics (FunctionBlock) Reader (FunctionBlock) SetInitialValue (Method) ReaderGroup (FunctionBlock) SetInitialValue (Method) Writer (FunctionBlock) SetInitialValue (Method) WriterGroup (FunctionBlock) SetInitialValue (Method) Functions DT_TO_UAVersionTime (Function) GetAsChar (Function) GetAsWChar (Function) STRING_SIZE_TO_UALEN (Function) WSTRING_SIZE_TO_UALEN (Function) Interfaces Diagnostics IConnectionDiagnostics (Interface) GetInstancePointer (Method) IDiagnostics (Interface) Reset (Method) IDiagnosticsCounter (Interface) GetInstancePointer (Method) IReaderDiagnostics (Interface) GetInstancePointer (Method) IReaderGroupDiagnostics (Interface) GetInstancePointer (Method) IRootDiagnostics (Interface) GetInstancePointer (Method) IWriterDiagnostics (Interface) GetInstancePointer (Method) IWriterGroupDiagnostics (Interface) GetInstancePointer (Method) IConfiguration (Interface) IConnection (Interface) IDataSet (Interface) GetSize (Method) GetVersion (Method) IReader (Interface) IReaderGroup (Interface) IStatus (Interface) Disable (Method) Enable (Method) GetState (Method) IWriter (Interface) IWriterGroup (Interface) Structs ArrayType (Struct) Index (Struct) UIndex (Struct) UMeta (Struct) VersionTime (Struct) Types IEC_TYPE (Alias) UNICODE (Alias)
Aliases ¶ Function Blocks AsyncProperty (Alias) IPAddressSet (Alias) IPv4Address (Alias) ResolveHostname (Alias) IPADDRESS (Alias) Interfaces IAsyncProperty (Alias) IIPAddress (Alias) IIPAddressSet (Alias) ITSNContext (Alias)
Function Blocks ¶ AsyncProperty (Alias) IPAddressSet (Alias) IPv4Address (Alias) ResolveHostname (Alias)
AsyncProperty (ALIAS) ¶ TYPE AsyncProperty : NBS.|dAsyncProperty| See: AsyncProperty in the Net Base Services library Example myAsyncProperty : UADP.AsyncProperty := ( tnTaskName := 'myTask' , usiTaskPrio := 10 , udiTaskInterval := 10000 (* µs *) ); myConnection : UADP.Connection := ( itfAsyncProperty := myAsyncProperty , uiPublisherId := 42 , itfIPAddress := ipAdapterAddress , itfPublisherIP := ipPublisherAddress , itfSubscriberIPSet := 0 );
IPAddressSet (ALIAS) ¶ TYPE IPAddressSet : NBS.|dIPAddressSet| See: IPAddressSet in the Net Base Services library
IPv4Address (ALIAS) ¶ TYPE IPv4Address : NBS.|dIPv4Address| See: IPv4Address in the Net Base Services library