ET_Result

Overview

Type:

Enumeration

Available as of:

V1.0.0.0

Description

The enumeration ET_Result contains the possible values that indicate the result of operations executed by the POUs of this library.

Enumeration Elements

Name

Value (UINT)

Description

If q_xError of a function block is FALSE, one of the following status messages is shown.

Disabled

0

The function block is disabled.

Disabling

1

Ongoing disabling process of the function block.

Initializing

2

An internal resource is being initialized.

Connecting

4

The attempt to establish a connection has been started but no result is available yet.

ConnectedToProxy

5

The connection to the proxy server is successfully established.

Connected

6

The connection to the server is successfully established.

Idle

7

The function block is ready to be executed.

SendingMessage

9

Sending message to server.

WaitForAcknowledge

10

Waiting for an acknowledged message from the server.

OK

99

The function block has been executed successfully.

If q_xError of a function block is TRUE, one of the following status messages is shown.

InvalidServerIP

100

The specified IP address is invalid.

InvalidServerPort

102

The specified port is invalid.

InvalidUsername

104

The specified username is invalid. It cannot be empty if a password is set.

InvalidClientID

106

The specified client identifier is invalid.

InvalidHostname

107

The specified host name is invalid.

HostnameAndIpNotAllowed

108

A value is assigned to both the parameters sHostname and sIpAddress.

If a proxy handler is assigned for the FB_MqttClient only one value is allowed for addressing the MQTT server; either the host name or the IP address.

ConnectFailed

110

Connection to the server was not successful.

NotConnected

111

No connection to the server. Verify the status of the FB_MqttClient instance.

InvalidTopic

112

The specified topic is invalid. It cannot be empty.

InvalidTopicLenght

114

The specified topic length is invalid. It cannot be 0.

InvalidMessage

116

The specified pointer to the data is invalid. It cannot be a null reference.

QoSNotSupported

118

The specified quality of service is not supported. Quality of service 0 and 1 are supported.

ConnectionRefused

120

The attempt to establish a connection is unsuccessful because the remote system denied it.

Verify that the identifier defined with the sClientId parameter does not exceed the length defined with the global constant GPL.Gc_uiMaxLengthOfClientID.

AlreadySubscribed

122

The specified topic is already subscribed by another FB_MqttSubscribe instance.

SubscribeFailed

123

The subscription to the given topic was not successful.

NumberOfSubscribtionsExceeded

124

Maximum number of subscriptions is exceeded. Refer to the value Gc_uiMaxNumberOfSubTotal.

NumberOfPublishesExceeded

126

Maximum number of publications is exceeded. Refer to the value Gc_uiMaxNumberOfQoS1PubPerClient.

SendingMessageFailed

140

The TCP operation to send a message to the server was not completed successfully.

ReceivingMessageFailed

145

The TCP operation to receive a message from the server was not completed successfully.

ProcessingBufferSizeTooSmall

150

The processing buffer size is too small. Refer to the value Gc_uiMaxSizeOfDataToExchange.

MqttClientInvalid

160

Invalid reference to FB_MqttClient instance.

InvalidBuffer

170

The specified pointer to the buffer is invalid. It cannot be a null reference.

NumberOfQos1MessagesExceeded

180

Maximum number of not processed messages is exceeded. Refer to the value Gc_uiMaxNumberOfQoS1MessagesPerSub.

UnsupportedMessageReceived

190

The message received from the server is not supported.

ConnectionInterrupted

200

The connection to the server was interrupted.

Timeout

300

A timeout has elapsed during execution.

InternalError

999

An internal error is detected.

Used By

  • FB_MqttClient

  • FB_MqttPublish

  • FB_MqttSubscribe