 |
C++ Based OPC UA Client/Server SDK
1.5.5.355
|
|
C++ Based OPC UA Client/Server SDK
1.5.5.355
|
The ServiceSettings class contains the general settings for a call. More...
#include <uaclientsdk.h>
Public Member Functions | |
| ServiceSettings () | |
| Creates a ServiceSettings object with callTimeout set to 10 seconds. More... | |
| ~ServiceSettings () | |
| Destroys the service settings object. More... | |
Public Attributes | |
| OpcUa_Int32 | callTimeout |
| The time-out for the service call in milliseconds. More... | |
| OpcUa_UInt32 | returnDiagnostics |
| Bit mask that defines the diagnostic information to be returned from the server. More... | |
| UaString | auditEntryId |
| An identifier that identifies the Client's security audit log entry associated with this request. More... | |
| UaStringArray | stringTable |
| UaString table for returned diagnostic information. More... | |
| OpcUa_UInt32 | requestHandle |
| Request handle used for the service call. More... | |
| UaDateTime | responseTimestamp |
| Timestamp of the response as returned by the server. More... | |
The ServiceSettings class contains the general settings for a call.
|
inline |
Creates a ServiceSettings object with callTimeout set to 10 seconds.
|
inline |
Destroys the service settings object.
| UaString UaClientSdk::ServiceSettings::auditEntryId |
An identifier that identifies the Client's security audit log entry associated with this request.
| OpcUa_Int32 UaClientSdk::ServiceSettings::callTimeout |
The time-out for the service call in milliseconds.
The default setting is 10 seconds.
| OpcUa_UInt32 UaClientSdk::ServiceSettings::requestHandle |
Request handle used for the service call.
The request handle is sent to the server in the RequestHeader and is used to cancel service invocations. If the request handle is not set (initial value is 0), a unique number is set by the SDK.
The SDK is using numbers above 1.000.000 for creating unique numbers. An application must make sure to only use numbers below 1.000.000 to avoid conflicts when cancel is called.
| UaDateTime UaClientSdk::ServiceSettings::responseTimestamp |
Timestamp of the response as returned by the server.
| OpcUa_UInt32 UaClientSdk::ServiceSettings::returnDiagnostics |
Bit mask that defines the diagnostic information to be returned from the server.
The default setting is 0.
| Bit Value | Diagnostics to return | Define |
|---|---|---|
| 0x0000 0001 | ServiceLevel / SymbolicId | OpcUa_DiagnosticsMasks_ServiceSymbolicId |
| 0x0000 0002 | ServiceLevel / LocalizedText | OpcUa_DiagnosticsMasks_ServiceLocalizedText |
| 0x0000 0004 | ServiceLevel / AdditionalInfo | OpcUa_DiagnosticsMasks_ServiceAdditionalInfo |
| 0x0000 0008 | ServiceLevel / Inner StatusCode | OpcUa_DiagnosticsMasks_ServiceInnerStatusCode |
| 0x0000 0010 | ServiceLevel / Inner Diagnostics | OpcUa_DiagnosticsMasks_ServiceInnerDiagnostics |
| 0x0000 0020 | OperationLevel / SymbolicId | OpcUa_DiagnosticsMasks_OperationSymbolicId |
| 0x0000 0040 | OperationLevel / LocalizedText | OpcUa_DiagnosticsMasks_OperationLocalizedText |
| 0x0000 0080 | OperationLevel / AdditionalInfo | OpcUa_DiagnosticsMasks_OperationAdditionalInfo |
| 0x0000 0100 | OperationLevel / Inner StatusCode | OpcUa_DiagnosticsMasks_OperationInnerStatusCode |
| 0x0000 0200 | OperationLevel / Inner Diagnostics | OpcUa_DiagnosticsMasks_OperationInnerDiagnostics |
Additional defines for combinations:
| Description | Define |
|---|---|
| All service level diagnostic information | OpcUa_DiagnosticsMasks_ServiceAll |
| All operation level diagnostic information | OpcUa_DiagnosticsMasks_OperationAll |
| All diagnostic information without inner status | OpcUa_DiagnosticsMasks_NoInnerStatus |
| All diagnostic information | OpcUa_DiagnosticsMasks_All |
| SymbolicId for service and operation level | OpcUa_DiagnosticsMasks_SymbolicId |
| LocalizedText for service and operation level | OpcUa_DiagnosticsMasks_LocalizedText |
| AdditionalInfo for service and operation level | OpcUa_DiagnosticsMasks_AdditionalInfo |
| UaStringArray UaClientSdk::ServiceSettings::stringTable |
UaString table for returned diagnostic information.