![](dotnetdiagramimages/OpcLabs_EasyOpcUA_OpcLabs_EasyOpc_UA_Engine_UAClientSessionParameters.png)
'Declaration
<ComDefaultInterfaceAttribute(OpcLabs.EasyOpc.UA.Engine.ComTypes._UAClientSessionParameters)> <ComVisibleAttribute(True)> <GuidAttribute("088E204B-29F9-4336-BB86-3270673DC5CD")> <TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)> <CLSCompliantAttribute(True)> <ValueControlAttribute("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.81.455.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", DefaultReadWrite=False, Export=True, PageId=10001)> <SerializableAttribute()> Public Class UAClientSessionParameters Inherits OpcLabs.BaseLib.Parameters Implements LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.BaseLib.ComTypes._Parameters, OpcLabs.EasyOpc.UA.Engine.ComTypes._UAClientSessionParameters, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
'Usage
Dim instance As UAClientSessionParameters
[ComDefaultInterface(OpcLabs.EasyOpc.UA.Engine.ComTypes._UAClientSessionParameters)] [ComVisible(true)] [Guid("088E204B-29F9-4336-BB86-3270673DC5CD")] [TypeConverter(System.ComponentModel.ExpandableObjectConverter)] [CLSCompliant(true)] [ValueControl("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.81.455.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", DefaultReadWrite=false, Export=true, PageId=10001)] [Serializable()] public class UAClientSessionParameters : OpcLabs.BaseLib.Parameters, LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.BaseLib.ComTypes._Parameters, OpcLabs.EasyOpc.UA.Engine.ComTypes._UAClientSessionParameters, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
[ComDefaultInterface(OpcLabs.EasyOpc.UA.Engine.ComTypes._UAClientSessionParameters)] [ComVisible(true)] [Guid("088E204B-29F9-4336-BB86-3270673DC5CD")] [TypeConverter(System.ComponentModel.ExpandableObjectConverter)] [CLSCompliant(true)] [ValueControl("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.81.455.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", DefaultReadWrite=false, Export=true, PageId=10001)] [Serializable()] public ref class UAClientSessionParameters : public OpcLabs.BaseLib.Parameters, LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.BaseLib.ComTypes._Parameters, OpcLabs.EasyOpc.UA.Engine.ComTypes._UAClientSessionParameters, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
In order to obtain or modify these parameters, in the default state (when OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated equals to false
), access UAClientAdaptableParameters.SessionParameters property of static OpcLabs.EasyOpc.UA.EasyUAClientCore.AdaptableParameters. If you have set OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated to true
, you need to access UAClientAdaptableParameters.SessionParameters property of OpcLabs.EasyOpc.UA.EasyUAClientCore.IsolatedParameters.
// This example shows how to set fairly short OPC UA timeouts (failures can thus occur). // // Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . // OPC client and subscriber examples in C# on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-CSharp . // Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own // a commercial license in order to use Online Forums, and we reply to every post. using System; using OpcLabs.EasyOpc.UA; namespace UADocExamples._UAClientSessionParameters { class Timeouts { public static void Isolated() { UAEndpointDescriptor endpointDescriptor = "opc.tcp://opcua.demo-this.com:51210/UA/SampleServer"; // or "http://opcua.demo-this.com:51211/UA/SampleServer" (currently not supported) // or "https://opcua.demo-this.com:51212/UA/SampleServer/" // Instantiate the client object and set timeouts var client = new EasyUAClient { Isolated = true, IsolatedParameters = { SessionParameters = { EndpointSelectionTimeout = 1500, SessionConnectTimeout = 3000, SessionTimeout = 3000, SessionTimeoutDebug = 3000 } } }; Console.WriteLine("Subscribing..."); // The callback is a lambda expression the displays the value client.SubscribeDataChange(endpointDescriptor, "nsu=http://test.org/UA/Data/ ;i=10853", 1000, (sender, eventArgs) => { if (eventArgs.Succeeded) Console.WriteLine("Value: {0}", eventArgs.AttributeData.Value); else Console.WriteLine("*** Failure: {0}", eventArgs.ErrorMessageBrief); }); Console.WriteLine("Processing data change events for 10 seconds..."); System.Threading.Thread.Sleep(10 * 1000); Console.WriteLine("Unsubscribing..."); client.UnsubscribeAllMonitoredItems(); Console.WriteLine("Waiting for 2 seconds..."); System.Threading.Thread.Sleep(2 * 1000); } } }
' This example shows how to set fairly short OPC UA timeouts (failures can thus occur). ' ' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . ' OPC client and subscriber examples in VB.NET on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-VBNET . ' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own ' a commercial license in order to use Online Forums, and we reply to every post. Imports OpcLabs.EasyOpc.UA Namespace _UAClientSessionParameters Partial Friend Class Timeouts Public Shared Sub Isolated() ' Define which server we will work with. Dim endpointDescriptor As UAEndpointDescriptor = "opc.tcp://opcua.demo-this.com:51210/UA/SampleServer" ' or "http://opcua.demo-this.com:51211/UA/SampleServer" (currently not supported) ' or "https://opcua.demo-this.com:51212/UA/SampleServer/" ' Instantiate the client object and set timeouts Dim client = New EasyUAClient() With { .Isolated = True, .IsolatedParameters = New Engine.EasyUAClientAdaptableParameters() With { .SessionParameters = New Engine.UASmartClientSessionParameters() With { .EndpointSelectionTimeout = 1500, .SessionConnectTimeout = 3000, .SessionTimeout = 3000, .SessionTimeoutDebug = 3000 } } } Console.WriteLine("Subscribing...") ' The callback is a lambda expression the displays the value client.SubscribeDataChange(endpointDescriptor, "nsu=http://test.org/UA/Data/ ;i=10853", 1000, Sub(sender, eventArgs) If eventArgs.Succeeded Then Console.WriteLine("Value: {0}", eventArgs.AttributeData.Value) Else Console.WriteLine("*** Failure: {0}", eventArgs.ErrorMessageBrief) End If End Sub) Console.WriteLine("Processing data change events for 10 seconds...") Threading.Thread.Sleep(10 * 1000) Console.WriteLine("Unsubscribing...") client.UnsubscribeAllMonitoredItems() Console.WriteLine("Waiting for 2 seconds...") Threading.Thread.Sleep(2 * 1000) End Sub End Class End Namespace
# This example shows how to set fairly short OPC UA timeouts (failures can thus occur). # # Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . # OPC client and subscriber examples in Python on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-Python . # Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own # a commercial license in order to use Online Forums, and we reply to every post. # The QuickOPC package is needed. Install it using "pip install opclabs_quickopc". import opclabs_quickopc import time # Import .NET namespaces. from OpcLabs.EasyOpc.UA import * from OpcLabs.EasyOpc.UA.OperationModel import * def dataChangeNotification(sender, eventArgs): # Display value. if eventArgs.Succeeded: print('Value: ', eventArgs.AttributeData.Value, sep='') else: print('*** Failure: ', eventArgs.ErrorMessageBrief, sep='') endpointDescriptor = UAEndpointDescriptor('opc.tcp://opcua.demo-this.com:51210/UA/SampleServer') # or 'http://opcua.demo-this.com:51211/UA/SampleServer' (currently not supported) # or 'https://opcua.demo-this.com:51212/UA/SampleServer/' # Instantiate the client object and set timeouts. client = EasyUAClient() client.Isolated = True client.IsolatedParameters.SessionParameters.EndpointSelectionTimeout = 1500 client.IsolatedParameters.SessionParameters.SessionConnectTimeout = 3000 client.IsolatedParameters.SessionParameters.SessionTimeout = 3000 client.IsolatedParameters.SessionParameters.SessionTimeoutDebug = 3000 print('Subscribing...') IEasyUAClientExtension.SubscribeDataChange(client, endpointDescriptor, UANodeDescriptor('nsu=http://test.org/UA/Data/ ;i=10853'), 1000, EasyUADataChangeNotificationEventHandler(dataChangeNotification)) print('Processing data change events for 10 seconds...') time.sleep(10) print('Unsubscribing...') client.UnsubscribeAllMonitoredItems() print('Waiting for 2 seconds...') time.sleep(2) print('Finished.')
// This example shows how in a console application, the user is asked to allow a server instance certificate with // mismatched domain name. // // Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . // OPC client and subscriber examples in C# on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-CSharp . // Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own // a commercial license in order to use Online Forums, and we reply to every post. using System; using OpcLabs.EasyOpc.UA; using OpcLabs.EasyOpc.UA.OperationModel; namespace UADocExamples.Interaction { class AllowEndpointDomain { public static void Main1() { // Define which server we will work with. // Note that extra '.' at the end of the domain name. For the purpose of this example, it allows us to address // the same domain, but cause a mismatch with what the names that are listed in the server instance certificate. UAEndpointDescriptor endpointDescriptor = "opc.tcp://opcua.demo-this.com.:51210/UA/SampleServer"; // Instantiate the client object. var client = new EasyUAClient() { // Enforce the endpoint domain check. Isolated = true, IsolatedParameters = {SessionParameters = {CheckEndpointDomain = true}} }; UAAttributeData attributeData; try { // Obtain attribute data. // The component automatically triggers the necessary user interaction during the first operation. attributeData = client.Read(endpointDescriptor, "nsu=http://test.org/UA/Data/ ;i=10853"); } catch (UAException uaException) { Console.WriteLine("*** Failure: {0}", uaException.GetBaseException().Message); return; } // Display results. Console.WriteLine("Value: {0}", attributeData.Value); Console.WriteLine("ServerTimestamp: {0}", attributeData.ServerTimestamp); Console.WriteLine("SourceTimestamp: {0}", attributeData.SourceTimestamp); Console.WriteLine("StatusCode: {0}", attributeData.StatusCode); } } }
' This example shows how in a console application, the user is asked to allow a server instance certificate with ' mismatched domain name. ' ' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . ' OPC client and subscriber examples in VB.NET on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-VBNET . ' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own ' a commercial license in order to use Online Forums, and we reply to every post. Imports OpcLabs.EasyOpc.UA Imports OpcLabs.EasyOpc.UA.OperationModel Imports OpcLabs.EasyOpc.UA.Engine Namespace Interaction Friend Class AllowEndpointDomain Public Shared Sub Main1() ' Define which server we will work with. ' Note that extra '.' at the end of the domain name. For the purpose of this example, it allows us to address ' the same domain, but cause a mismatch with what the names that are listed in the server instance certificate. Dim endpointDescriptor As UAEndpointDescriptor = "opc.tcp://opcua.demo-this.com.:51210/UA/SampleServer" ' Instantiate the client object. Dim client = New EasyUAClient() With { .Isolated = True, .IsolatedParameters = New EasyUAClientAdaptableParameters() With { .SessionParameters = New UASmartClientSessionParameters() With { .CheckEndpointDomain = True } } } Dim attributeData As UAAttributeData Try ' Obtain attribute data. ' The component automatically triggers the necessary user interaction during the first operation. attributeData = client.Read(endpointDescriptor, "nsu=http://test.org/UA/Data/ ;i=10853") Catch uaException As UAException Console.WriteLine("*** Failure: {0}", uaException.GetBaseException.Message) Exit Sub End Try ' Display results. Console.WriteLine("Value: {0}", attributeData.Value) Console.WriteLine("ServerTimestamp: {0}", attributeData.ServerTimestamp) Console.WriteLine("SourceTimestamp: {0}", attributeData.SourceTimestamp) Console.WriteLine("StatusCode: {0}", attributeData.StatusCode) End Sub End Class End Namespace
// This example shows how in a console application, the user is asked to allow a server instance certificate with // mismatched domain name. // // Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . // OPC client and subscriber examples in Object Pascal (Delphi) on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-OP . // Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own // a commercial license in order to use Online Forums, and we reply to every post. class procedure AllowEndpointDomain.Main; var AttributeData: _UAAttributeData; Client: _EasyUAClient; EndpointDescriptor: string; begin // Define which server we will work with. // Note that extra '.' at the end of the domain name. For the purpose of this example, it allows us to address // the same domain, but cause a mismatch with what the names that are listed in the server instance certificate. EndpointDescriptor := 'opc.tcp://opcua.demo-this.com.:51210/UA/SampleServer'; // Instantiate the client object. Client := CoEasyUAClient.Create; // Enforce the endpoint domain check. Client.Isolated := true; Client.IsolatedParameters.SessionParameters.CheckEndpointDomain := true; try // Obtain attribute data. // The component automatically triggers the necessary user interaction during the first operation. AttributeData := Client.Read(EndpointDescriptor, 'nsu=http://test.org/UA/Data/ ;i=10853'); except on E: EOleException do begin WriteLn(Format('*** Failure: %s', [E.GetBaseException.Message])); Exit; end; end; // Display results. WriteLn('Value: ', AttributeData.Value); WriteLn('ServerTimestamp: ', DateTimeToStr(AttributeData.ServerTimestamp)); WriteLn('SourceTimestamp: ', DateTimeToStr(AttributeData.SourceTimestamp)); WriteLn('StatusCode: ', AttributeData.StatusCode.ToString); end;
Rem This example shows how in a console application, the user is asked to allow a server instance certificate with Rem mismatched domain name. Rem Rem Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . Rem OPC client and subscriber examples in VBScript on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-VBScript . Rem Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own Rem a commercial license in order to use Online Forums, and we reply to every post. Option Explicit ' Define which server we will work with. ' Note that extra '.' at the end of the domain name. For the purpose of this example, it allows us to address ' the same domain, but cause a mismatch with what the names that are listed in the server instance certificate. Dim endpointDescriptor: endpointDescriptor = "opc.tcp://opcua.demo-this.com.:51210/UA/SampleServer" ' Instantiate the client object. Dim Client: Set Client = CreateObject("OpcLabs.EasyOpc.UA.EasyUAClient") ' Enforce the endpoint domain check. Client.Isolated = True Client.IsolatedParameters.SessionParameters.CheckEndpointDomain = True ' Obtain attribute data. ' The component automatically triggers the necessary user interaction during the first operation. On Error Resume Next Dim AttributeData: Set AttributeData = Client.Read(endpointDescriptor, "nsu=http://test.org/UA/Data/ ;i=10853") If Err.Number <> 0 Then WScript.Echo "*** Failure: " & Err.Source & ": " & Err.Description WScript.Quit End If On Error Goto 0 ' Display results WScript.Echo "Value: " & AttributeData.Value WScript.Echo "ServerTimestamp: " & AttributeData.ServerTimestamp WScript.Echo "SourceTimestamp: " & AttributeData.SourceTimestamp WScript.Echo "StatusCode: " & AttributeData.StatusCode ' Example output: ' 'OPC-UA Endpoint Domain Mismatch 'The effective host name in endpoint URL returned by the server does not match any of the domain names in the server certificate. 'Endpoint URL as returned by the server: opc.tcp://opcua.demo-this.com.:51210/UA/SampleServer 'The server certificate is for following domain names or IP addresses: opcua.demo-this.com 'This may be an indication of a spoofing attempt. Do you want to allow the endpoint anyway? [Y/n]: Y 'Value: -1.285897E+14 'ServerTimestamp: 11/28/2019 1:34:23 PM 'SourceTimestamp: 11/28/2019 1:34:23 PM 'StatusCode: Good
# This example shows how in a console application, the user is asked to allow a server instance certificate with # mismatched domain name. # # Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . # OPC client and subscriber examples in Python on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-Python . # Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own # a commercial license in order to use Online Forums, and we reply to every post. # The QuickOPC package is needed. Install it using "pip install opclabs_quickopc". import opclabs_quickopc # Import .NET namespaces. from OpcLabs.EasyOpc.UA import * from OpcLabs.EasyOpc.UA.OperationModel import * # Define which server we will work with. # Note that extra '.' at the end of the domain name. For the purpose of this example, it allows us to address # the same domain, but cause a mismatch with what the names that are listed in the server instance certificate. endpointDescriptor = UAEndpointDescriptor('opc.tcp://opcua.demo-this.com.:51210/UA/SampleServer') # Instantiate the client object. client = EasyUAClient() # Enforce the endpoint domain check. client.Isolated = True client.IsolatedParameters.SessionParameters.CheckEndpointDomain = True try: # Obtain attribute data. # The component automatically triggers the necessary user interaction during the first operation. attributeData = IEasyUAClientExtension.Read(client, endpointDescriptor, UANodeDescriptor('nsu=http://test.org/UA/Data/ ;i=10853')) except UAException as uaException: print('*** Failure: ' + uaException.GetBaseException().Message) exit() # Display results. print('Value: ', attributeData.Value) print('ServerTimestamp: ', attributeData.ServerTimestamp) print('SourceTimestamp: ', attributeData.SourceTimestamp) print('StatusCode: ', attributeData.StatusCode) print() print('Finished.')
// Shows an OPC UA data change observable with specified timeouts. // // Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html . // OPC client and subscriber examples in C# on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-CSharp . // Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own // a commercial license in order to use Online Forums, and we reply to every post. using OpcLabs.EasyOpc.UA.Reactive; using System; using System.Threading; using OpcLabs.EasyOpc.UA; namespace ReactiveDocExamples { namespace _UADataChangeNotificationObservable { partial class Subscribe { public static void Timeouts() { // Define which server we will work with. UAEndpointDescriptor endpointDescriptor = "opc.tcp://opcua.demo-this.com:51210/UA/SampleServer"; // or "http://opcua.demo-this.com:51211/UA/SampleServer" (currently not supported) // or "https://opcua.demo-this.com:51212/UA/SampleServer/" Console.WriteLine("Creating observable..."); UADataChangeNotificationObservable<float> observable = UADataChangeNotificationObservable.Create<float>( endpointDescriptor, "nsu=http://test.org/UA/Data/ ;i=10853", 1000); // Set fairly short timeouts (failure can thus occur). observable.ClientSelector.Isolated = true; observable.ClientSelector.IsolatedParameters.SessionParameters.EndpointSelectionTimeout = 1500; observable.ClientSelector.IsolatedParameters.SessionParameters.SessionConnectTimeout = 3000; observable.ClientSelector.IsolatedParameters.SessionParameters.SessionTimeout = 3000; observable.ClientSelector.IsolatedParameters.SessionParameters.SessionTimeoutDebug = 3000; Console.WriteLine("Subscribing..."); using (observable.Subscribe(e => Console.WriteLine( (e.Exception is null) ? e.AttributeData.ToString() : e.Exception.GetBaseException().ToString()))) { Console.WriteLine("Waiting for 10 seconds..."); Thread.Sleep(10*1000); Console.WriteLine("Unsubscribing..."); } Console.WriteLine("Waiting for 2 seconds..."); Thread.Sleep(2 * 1000); } } } }
System.Object
OpcLabs.BaseLib.Object2
OpcLabs.BaseLib.Info
OpcLabs.BaseLib.Parameters
OpcLabs.EasyOpc.UA.Engine.UAClientSessionParameters
OpcLabs.EasyOpc.UA.Engine.UAEnhancedClientSessionParameters