FB_SendVisionDataServer - ConfigurationTLS (Method)

Overview

Type:

Method

Available as of:

V1.7.3.0

This chapter provides information on:

Task

Configure the IP address and the port for connection to a client.

Description

With the method ConfigurationTLS, the IP address and the port can be configured for the client to send data to and the TLS settings that are used.

The configuration of the function block with this method will establish a secure connection, the client also must support a TLS connection.

If the client is not supporting TLS, the ConfigurationNoTLS method must be used.

Interface

Input

Data type

Description

i_sIpAddress

STRING[15]

IP address of the client the data is to be sent to.

i_uiPort

UINT

Source port of the client the data is to be sent to.

i_stTlsSettings

TCPUDP.ST_TlsSettingsServer.

TLS settings for the connection.

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic. A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Diagnostic message

q_sMsg

STRING[80]

Event-triggered message that gives more detailed information on the diagnostic state.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

Ok

0

Ok

ExecutionAborted

ConfigurationAlreadyCompleted

12

Configuration already successfully completed.

InputParameterInvalid

IpAddressInvalid

13

IP address is invalid.

ConfigurationAlreadyCompleted

Enumeration name:

ConfigurationAlreadyCompleted

Enumeration value:

12

Description:

The configuration has already been completed.

Issue

Cause

Solution

Configuration already successfully completed.

The method ConfigurationTLS(..) or the method ConfigurationNoTLS(..) has already been called up successfully.

Verify that the method ConfigurationTLS(..) or the method ConfigurationNoTLS(..) is not called after configuration was successful.

IpAddressInvalid

Enumeration name:

IpAddressInvalid

Enumeration value:

13

Description:

The IP address is invalid.

Issue

Cause

Solution

The IP address is invalid.

The IP address is invalid.

Verify that i_sIpAddress provides a valid IP address.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

Status message: Configuration of IP address and port was successful.