 |
ANSI C Based OPC UA Client/Server SDK
1.9.0.430
|
|
ANSI C Based OPC UA Client/Server SDK
1.9.0.430
|
Contains the configuration of the UaClient. More...
#include <uaclient.h>
Data Fields | |
| OpcUa_UInt | DefaultSecureChannelLifetime |
| The lifetime of the SecureChannel in milliseconds before it gets renewed. More... | |
| OpcUa_UInt | DefaultConnectTimeout |
| The timeout for the calls for SecureChannel and Session creation in milliseconds. More... | |
| OpcUa_UInt | DefaultDisconnectTimeout |
| The timeout for the call for closing a Session in milliseconds. More... | |
| OpcUa_UInt | DefaultCallTimeout |
| The timeout for service calls in milliseconds. More... | |
| OpcUa_UInt | DefaultSessionTimeout |
| The timeout for the application session in milliseconds. More... | |
| OpcUa_UInt | DefaultPublishTimeout |
| The timeout for publish calls in milliseconds. More... | |
| OpcUa_Boolean | DefaultWatchdogEnabled |
| Enable watchdog reads. More... | |
| OpcUa_UInt | DefaultWatchdogTime |
| The time between watchdog checks in milliseconds. More... | |
| OpcUa_UInt | DefaultWatchdogTimeout |
| The timeout for watchdog calls in milliseconds. More... | |
| OpcUa_Boolean | DefaultAutomaticReconnect |
| A flag indicating if the client SDK should try to reconnect in the case of a connection error. More... | |
| OpcUa_UInt | DefaultReconnectDelay |
| The delay between reconnect attempts in milliseconds. More... | |
| OpcUa_Boolean | DefaultCreateSignatureWithChain |
| For calculating the client signature, the client appends the server certificate to the server nonce. More... | |
| OpcUa_Double | DefaultPublishingInterval |
| The PublishingInterval defines the cyclic rate in milliseconds at which the subscription is being requested to return notifications to the client. More... | |
| OpcUa_UInt | DefaultLifetimeCount |
| The subscription has a lifetime that is defined by multiples of the publishingInterval. More... | |
| OpcUa_UInt | DefaultMaxKeepAliveCount |
| If the server has no notifications pending for the period of time defined by (MaxKeepAliveCount * PublishingInterval), the server will send a keep alive message to the client. More... | |
| OpcUa_ApplicationDescription | ApplicationDescription |
| Information about the client that will be sent to the server. More... | |
| OpcUa_Boolean | DefaultDisableErrorCertificateTimeInvalid |
| Flag used to disable the server certificate validation error BadCertificateTimeInvalid, default is false. More... | |
| OpcUa_Boolean | DefaultDisableErrorCertificateIssuerTimeInvalid |
| Flag used to disable the server certificate validation error BadCertificateIssuerTimeInvalid, default is false. More... | |
| OpcUa_Boolean | DefaultDisableErrorCertificateRevocationUnknown |
| Flag used to disable the server certificate validation error BadCertificateRevocationUnknown, default is false. More... | |
| OpcUa_Boolean | DefaultDisableErrorCertificateIssuerRevocationUnknown |
| Flag used to disable the server certificate validation error BadCertificateIssuerRevocationUnknown, default is false. More... | |
| OpcUa_Boolean | DefaultDisableApplicationUriCheck |
| Flag used to disable the ApplicationUri match check between server certificate and parameter in CreateSession. More... | |
| OpcUa_Boolean | DefaultDisableDomainCheck |
| If set to true, the domain in the endpoint URL will not be compared to the certificate domains, default is false. More... | |
| OpcUa_Boolean | DefaultDisableCertificateUsageCheck |
| If set to true, the certificate usage fields will not be checked, default is false. More... | |
| OpcUa_String | ClientCertificateLocation |
| Path to the certificate file of the client. More... | |
| OpcUa_String | ClientPrivateKeyLocation |
| Path to the private key file of the client. More... | |
| OpcUa_UInt32 | NoOfAdditionalCertificates |
| Number of additional certificates. More... | |
| OpcUa_String * | pAdditionalCertificates |
| Additional certificates that will be appended to the client certificate to form the certificate chain. More... | |
| OpcUa_CertificateStoreConfiguration | PkiConfig |
| The PKI configuration of the client. More... | |
Contains the configuration of the UaClient.
| OpcUa_ApplicationDescription UaClient_Configuration::ApplicationDescription |
Information about the client that will be sent to the server.
| OpcUa_String UaClient_Configuration::ClientCertificateLocation |
Path to the certificate file of the client.
| OpcUa_String UaClient_Configuration::ClientPrivateKeyLocation |
Path to the private key file of the client.
| OpcUa_Boolean UaClient_Configuration::DefaultAutomaticReconnect |
A flag indicating if the client SDK should try to reconnect in the case of a connection error.
The default value is OpcUa_True.
| OpcUa_UInt UaClient_Configuration::DefaultCallTimeout |
The timeout for service calls in milliseconds.
The default setting is 10 seconds.
| OpcUa_UInt UaClient_Configuration::DefaultConnectTimeout |
The timeout for the calls for SecureChannel and Session creation in milliseconds.
The default value for the connect timeout is 5000 milliseconds.
| OpcUa_Boolean UaClient_Configuration::DefaultCreateSignatureWithChain |
For calculating the client signature, the client appends the server certificate to the server nonce.
If the server sends a certificate chain, the client should only use the leaf certificate to calculate the client signature. With this setting enabled, the client uses the complete certificate chain instead. This is not the recommended behaviour. Only set this flag to work around interoperability issues with misbehaving servers.
| OpcUa_Boolean UaClient_Configuration::DefaultDisableApplicationUriCheck |
Flag used to disable the ApplicationUri match check between server certificate and parameter in CreateSession.
The check is required for compliant OPC UA servers but older clients may provide a wrong ApplicationUri, default is false.
| OpcUa_Boolean UaClient_Configuration::DefaultDisableCertificateUsageCheck |
If set to true, the certificate usage fields will not be checked, default is false.
| OpcUa_Boolean UaClient_Configuration::DefaultDisableDomainCheck |
If set to true, the domain in the endpoint URL will not be compared to the certificate domains, default is false.
| OpcUa_Boolean UaClient_Configuration::DefaultDisableErrorCertificateIssuerRevocationUnknown |
Flag used to disable the server certificate validation error BadCertificateIssuerRevocationUnknown, default is false.
| OpcUa_Boolean UaClient_Configuration::DefaultDisableErrorCertificateIssuerTimeInvalid |
Flag used to disable the server certificate validation error BadCertificateIssuerTimeInvalid, default is false.
| OpcUa_Boolean UaClient_Configuration::DefaultDisableErrorCertificateRevocationUnknown |
Flag used to disable the server certificate validation error BadCertificateRevocationUnknown, default is false.
| OpcUa_Boolean UaClient_Configuration::DefaultDisableErrorCertificateTimeInvalid |
Flag used to disable the server certificate validation error BadCertificateTimeInvalid, default is false.
| OpcUa_UInt UaClient_Configuration::DefaultDisconnectTimeout |
The timeout for the call for closing a Session in milliseconds.
The default value for the disconnect timeout is 5000 milliseconds.
| OpcUa_UInt UaClient_Configuration::DefaultLifetimeCount |
The subscription has a lifetime that is defined by multiples of the publishingInterval.
In other words if the client can't communicate with the server for a period of time shorter than (LifetimeCount * PublishingInterval), then the subscription is still available in the server. After that, the server will delete the subscription. With a publishingInterval of 1000 ms, the default is 20 minutes like the default lifetime of the session. Please make sure to adjust the lifetimeCount if you change the publishingInterval.
| OpcUa_UInt UaClient_Configuration::DefaultMaxKeepAliveCount |
If the server has no notifications pending for the period of time defined by (MaxKeepAliveCount * PublishingInterval), the server will send a keep alive message to the client.
Thus, client and server know that the other side is still alive even if no data has been exchanged for some time.
| OpcUa_Double UaClient_Configuration::DefaultPublishingInterval |
The PublishingInterval defines the cyclic rate in milliseconds at which the subscription is being requested to return notifications to the client.
| OpcUa_UInt UaClient_Configuration::DefaultPublishTimeout |
The timeout for publish calls in milliseconds.
The PublishTimeout is the timeout for Publish requests. It is often necessary to set a higher PublishTimeout because Clients need to make sure that Publish requests are used before they time out. As a rule of thumb the PublishTimeout should be twice as long as the longest MaxKeepAliveCount.
| OpcUa_UInt UaClient_Configuration::DefaultReconnectDelay |
The delay between reconnect attempts in milliseconds.
The default value for the reconnect delay is 5000 milliseconds.
| OpcUa_UInt UaClient_Configuration::DefaultSecureChannelLifetime |
The lifetime of the SecureChannel in milliseconds before it gets renewed.
This is the time the key pair exchanged during secure channel establishment are valid. The stack starts the renew process that exchanges new key pairs after 75% of the lifetime. The default lifetime is one hour.
| OpcUa_UInt UaClient_Configuration::DefaultSessionTimeout |
The timeout for the application session in milliseconds.
The client library ensures that the session does not time out as long as the client application does not call disconnect. The session can time out if the network connection is broken for longer than the defined session timeout. A long timeout ensures that the established application session can be reused after the longer network interruption. Default value is 20 minutes. This timeout has no effect for the individual timeout for a service call (which is set with DefaultCallTimeout). This timeout is only used to ensure that the server is able to release resources if a client is disconnected for a long time.
| OpcUa_Boolean UaClient_Configuration::DefaultWatchdogEnabled |
Enable watchdog reads.
| OpcUa_UInt UaClient_Configuration::DefaultWatchdogTime |
The time between watchdog checks in milliseconds.
The default value for the watchdog time is 5000 milliseconds. The minimum value accepted by the SDK is 1000 milliseconds.
| OpcUa_UInt UaClient_Configuration::DefaultWatchdogTimeout |
The timeout for watchdog calls in milliseconds.
After one unsuccessful call, the timeout will be two times this value for the next call.
The default value for the watchdog time is 5000 milliseconds.
| OpcUa_UInt32 UaClient_Configuration::NoOfAdditionalCertificates |
Number of additional certificates.
| OpcUa_String* UaClient_Configuration::pAdditionalCertificates |
Additional certificates that will be appended to the client certificate to form the certificate chain.
| OpcUa_CertificateStoreConfiguration UaClient_Configuration::PkiConfig |
The PKI configuration of the client.