C++ Based OPC UA Client/Server SDK  1.5.3.346
UA Client context and helper classes

This module contains all C++ helper and context classes used in the OPC UA Client SDK. More...

Namespaces

 UaClientSdk
 Namespace for the C++ OPC UA Client Library.
 

Classes

class  UaClientSdk::UaClient
 Namespace class for OPC UA Client Library. More...
 
class  UaClientSdk::SessionConnectInfo
 The SessionConnectInfo class contains the session settings for connect. More...
 
class  UaClientSdk::ClientSecurityInfo
 The ClientSecurityInfo class contains the security related settings to create a secure channel. More...
 
class  UaClientSdk::CertificateValidationCallback
 The CertificateValidationCallback is an interface for retrieving information about certificate validation errors. More...
 
class  UaClientSdk::SessionSecurityInfo
 The SessionSecurityInfo class contains the security related session settings for connect. More...
 
class  UaClientSdk::ServiceSettings
 The ServiceSettings class contains the general settings for a call. More...
 
class  UaClientSdk::BrowseContext
 The BrowseContext class contains the settings for a browse request. More...
 
class  UaClientSdk::HistoryReadRawModifiedContext
 The HistoryReadRawModifiedContext class contains the settings for a HistoryReadRawModified call. More...
 
class  UaClientSdk::HistoryReadProcessedContext
 The HistoryReadProcessedContext class contains the settings for a HistoryReadProcessed call. More...
 
class  UaClientSdk::HistoryReadAtTimeContext
 The HistoryReadAtTimeContext class contains the settings for a HistoryReadAtTime call. More...
 
class  UaClientSdk::HistoryReadDataResult
 The HistoryReadDataResult class contains the result for one item in a HistoryRead call for data. More...
 
class  UaClientSdk::HistoryReadEventContext
 The HistoryReadEventContext class contains the settings for a HistoryReadEvent call. More...
 
class  UaClientSdk::HistoryReadEventResult
 The HistoryReadDataResult class contains the result for one item in a HistoryRead call for data. More...
 
class  UaClientSdk::UpdateDataDetail
 The UpdateDataDetail class contains the data for one item in a HistoryUpdate call for data. More...
 
class  UaClientSdk::DeleteRawModifiedDetail
 The DeleteRawModifiedDetail class contains the data for one item in a HistoryUpdate call for data. More...
 
class  UaClientSdk::DeleteAtTimeDetail
 The DeleteRawModifiedDetail class contains the data for one item in a HistoryUpdate call for data. More...
 
class  UaClientSdk::UpdateEventDetail
 The UpdateEventsDetail class contains the data for one item in a HistoryUpdate call for events. More...
 
class  UaClientSdk::DeleteEventDetail
 The DeleteRawModifiedDetail class contains the data for one item in a HistoryUpdate call for data. More...
 
class  UaClientSdk::CallIn
 The CallIn class contains the settings for a call request. More...
 
class  UaClientSdk::CallOut
 The CallOut class contains the settings for a call request. More...
 
class  UaClientSdk::SubscriptionSettings
 The SubscriptionSettings class contains the settings for a Subscription. More...
 
class  UaClientSdk::UaSessionCallback
 UaSessionCallback defines the callback interface for the UaSession class. More...
 
class  UaClientSdk::UaSubscriptionCallback
 UaSubscriptionCallback defines the callback interface for the UaSubscription class. More...
 

Enumerations

enum  UaClientSdk::UaClient::ServerStatus {
  UaClientSdk::UaClient::Disconnected, UaClientSdk::UaClient::Connected, UaClientSdk::UaClient::ConnectionWarningWatchdogTimeout, UaClientSdk::UaClient::ConnectionErrorApiReconnect,
  UaClientSdk::UaClient::ServerShutdown, UaClientSdk::UaClient::NewSessionCreated
}
 OPC UA server status enumeration used to indicate the connection status in the client API. More...
 
enum  UaClientSdk::UaClient::ConnectServiceType { UaClientSdk::UaClient::CertificateValidation, UaClientSdk::UaClient::OpenSecureChannel, UaClientSdk::UaClient::CreateSession, UaClientSdk::UaClient::ActivateSession }
 Service type enumeration used to indicate a connection establishment step in the client API. More...
 
enum  UaClientSdk::UaClient::ReadTypeDictionaries { UaClientSdk::UaClient::ReadTypeDictionaries_FirstUse = 0, UaClientSdk::UaClient::ReadTypeDictionaries_Manual, UaClientSdk::UaClient::ReadTypeDictionaries_Connect, UaClientSdk::UaClient::ReadTypeDictionaries_Reconnect }
 Enumeration used to define the access to the data type dictionary. More...
 

Detailed Description

This module contains all C++ helper and context classes used in the OPC UA Client SDK.

Enumeration Type Documentation

Service type enumeration used to indicate a connection establishment step in the client API.

Enumerator
CertificateValidation 

Certificate validation steps.

OpenSecureChannel 

Processing of Service OpenSecureChannel.

CreateSession 

Processing of Service CreateSession.

ActivateSession 

Processing of Service ActivateSession.

Enumeration used to define the access to the data type dictionary.

Enumerator
ReadTypeDictionaries_FirstUse 

The data type dictionary is read when used the first time by the client application.

ReadTypeDictionaries_Manual 

Reading the data type dictionary must be triggered manually through UaSession::loadDataTypeDictionaries().

ReadTypeDictionaries_Connect 

The data type dictionary is read during connection establishment to the server.

ReadTypeDictionaries_Reconnect 

The data type dictionary is read during connection establishment and reconnect.

OPC UA server status enumeration used to indicate the connection status in the client API.

Enumerator
Disconnected 

The connection to the server is deactivated by the user of the client API.

Connected 

The connection to the server is established and is working in normal mode.

ConnectionWarningWatchdogTimeout 

The monitoring of the connection to the server indicated a potential connection problem.

ConnectionErrorApiReconnect 

The monitoring of the connection to the server detected an error and is trying to reconnect to the server.

ServerShutdown 

The server sent a shut-down event and the client API tries a reconnect.

NewSessionCreated 

The client was not able to reuse the old session and created a new session during reconnect. This requires to redo register nodes for the new session or to read the namespace array.