Namespace: Opc.UaFx
Assemblies: Opc.UaFx.Advanced.dll, Opc.UaFx.Advanced.dll
The OpcApplicationInstance<t, y> type exposes the following members.
C#
protected OpcApplicationInstance(OpcApplicationType type)
Parameters
type
OpcApplicationType
Exceptions
Occurs when the certificate of this application instance could not automatically determined using the information of this application instance. This event is when used to query the certificate to use for the application instance. Additionally use this event to determine the case that an appropriate instance certificate is missing and in case there AutoCreateCertificate of CertificateStores is equals true a new certificate is being created automatically after the event has been processed (and this may take some time).
C#
public event OpcCertificateRequestedEventHandler CertificateRequested
Occurs when the validation of a opponent application instance certificate does not fulfill the requirements for valid and trusted certificates.
C#
public event OpcCertificateValidationFailedEventHandler CertificateValidationFailed
Remarks
This event can be used to complement the default validation of opponent application instance certificates. Using the event arguments it is possible to accept the certificate using different/custom circumstances.
Gets or sets the name of the application.
C#
public virtual string ApplicationName { get; set; }
Property Value
The name of the application. The default value is “OPC Application” in case there is no entry assembly available; otherwise the value of the AssemblyTitleAttribute of the entry assembly.
Remarks
The name does not have to be unique. The value of this property is also used as the Cryptography.X509Certificates.X509Certificate2.SubjectName of the application certificate whenever an application certificate is to be created/looked-up (from the application certificates store).
Gets or sets the URI of the application.
C#
public Uri ApplicationUri { get; set; }
Property Value
The Uri or a null reference (Nothing in Visual Basic) which uniquely identifies the application instance.
Remarks
In case there the value of this property is a null reference (Nothing in Visual Basic) the URI of the application is determined by the subject alternate name of the application certificate used. In case there an application certificate is to be automatically created (if Certificate is unspecified and AutoCreateCertificate is equals true), this value is used to define the certificates subject alternate name.
If there exists already an application certificate the value of this property is replaced with the subject alternate name in the certificate. Nevertheless another URI has been manually configured.
Gets or sets the application certificate representing the applications identity. Changing the application certificate using this property will change the PathType of the ApplicationStore to System.
C#
public X509Certificate2 Certificate { get; set; }
Property Value
Cryptography.X509Certificates.X509Certificate2
An instance of the Cryptography.X509Certificates.X509Certificate2 class used to identify the application instance.
Gets the OpcCertificateStores instance used to maintain the different certificate stores used by the server application.
C#
public OpcCertificateStores CertificateStores { get; }
Property Value
An instance of the OpcCertificateStores class used by the IOpcApplicationInstance to setup and maintain the certificate stores and their certificates used by the application.
Gets or sets an instance of the OpcApplicationConfiguration class which is used as a low-level representation of the code/file based application configuration.
C#
[CLSCompliant(false)] public virtual OpcApplicationConfiguration Configuration { get; set; }
Property Value
An instance of the OpcApplicationConfiguration class configured with the application specific setup to use. An assignment of a null reference (Nothing in Visual Basic) will lead to the creation of a new instance of the OpcApplicationConfiguration class with all defaults typically used by this type of applications.
Gets a read-only collection of namespaces used by the application instance.
C#
public abstract OpcReadOnlyNamespaceCollection Namespaces { get; }
Property Value
OpcReadOnlyNamespaceCollection
An instance of the OpcReadOnlyNamespaceCollection class with OpcNamespace items for each 'NamespaceUri' known/used.
Gets or sets the URI of the product.
C#
public Uri ProductUri { get; set; }
Property Value
The Uri or a null reference (Nothing in Visual Basic) which uniquely identifies the product.
Remarks
In case there the value of this property is a null reference (Nothing in Visual Basic) the URI of the product is determined by the AssemblyCompanyAttribute and AssemblyProductAttribute used.
Gets the TSecurity
instance used to maintain the different security options used by the application instance.
C#
public TSecurity Security { get; }
Property Value
An instance of the TSecurity
class used by the application instance to setup and maintain the different security options.
Gets the OpcContext which is used to store the context sensitive data and configuration used by the current application instance.
C#
public abstract OpcContext SystemContext { get; }
Property Value
An instance of the OpcContext class which might be at least Empty.
Gets the TTransport
instance used to maintain the different transport options used by the application instance.
C#
public TTransport Transport { get; }
Property Value
An instance of the TTransport
class used by the application instance to setup and maintain the different transport options.
Verifies whether the current IOpcApplicationInstance instance has been already disposed of. In the case there isDisposed is equals true an ObjectDisposedException will be thrown.
C#
protected void DenyIfIsDisposed()
Exceptions
The object has been disposed of.
Releases the unmanaged resources used by the IOpcApplicationInstance and optionally releases the managed resources.
C#
protected virtual void Dispose(bool disposing)
Parameters
disposing
Boolean
The value true to release both managed and unmanaged resources; otherwise the value false to release only unmanaged resources.
Determines if the address
specified is supported.
C#
public static bool IsAddressSupported(string address)
Parameters
address
String
A string representing the Uri to evaluate.
Returns
The value true if the address
is supported; otherwise the value false.
Remarks
The value of the address
parameter can also be a null reference (Nothing in Visual Basic) or an empty string. In both cases the result will be false.
Determines if the address
specified is supported.
C#
public static bool IsAddressSupported(Uri address)
Parameters
address
Uri
The Uri to evalatuate.
Returns
The value true if the address
is supported; otherwise the value false.
Remarks
The value the address
parameter can be a null reference (Nothing in Visual Basic). In this case the result of the will be false.
Raises the CertificateRequested event of the application instance.
C#
protected virtual void OnCertificateRequested(OpcCertificateRequestedEventArgs e)
Parameters
e
OpcCertificateRequestedEventArgs
The event data.
Raises the CertificateValidationFailed event of the application instance.
C#
protected virtual void OnCertificateValidationFailed(OpcCertificateValidationFailedEventArgs e)
Parameters
e
OpcCertificateValidationFailedEventArgs
The event data.
C#
[CLSCompliant(false)] protected virtual void Setup(OpcApplicationConfiguration configuration)
Parameters
configuration
OpcApplicationConfiguration