OPC UA .NET API

The public .NET API of OPC UA.

All kindsClassConstructorEnumEnumeratorFieldMethodNamespacePropertyStruct71 symbols

• ResponseInfo.BinaryId Field — The numeric binary encoding ID (namespace 0) of the response body: the expected response type, or ServiceFault.
• ResponseInfo.RequestId Field — The client-local request ID returned by Client.Begin.
• ResponseInfo.ServiceStatus Field — The serviceResult status code from the response header; a Bad code has the top bit (0x80000000) set.
• SecurityMode.None Enumerator — Messages are neither signed nor encrypted; only valid with SecurityPolicy.None.
• SecurityMode.Sign Enumerator — Messages are signed.
• SecurityMode.SignAndEncrypt Enumerator — Messages are signed and encrypted; the default.
• SecurityPolicy.Aes128Sha256RsaOaep Enumerator — The Aes128_Sha256_RsaOaep policy.
• SecurityPolicy.Aes256Sha256RsaPss Enumerator — The Aes256_Sha256_RsaPss policy; the default.
• SecurityPolicy.Basic256Sha256 Enumerator — The Basic256Sha256 policy.
• SecurityPolicy.None Enumerator — No security (http://opcfoundation.org/UA/SecurityPolicy#None); requires explicit opt-in.
• VariableFlags.None Enumerator — Read-only, and readable only by authenticated (non-anonymous) sessions.
• VariableFlags.Public Enumerator — Anonymous sessions may access the variable as well.
• VariableFlags.Writable Enumerator — Clients may write the value.
• BinaryBuffer.Copy Method — Copies the buffer's contents into a new array.
• BinaryBuffer.Dispose Method — Releases the native buffer.
• Client.ActivateAnonymous Method — Activates the session with an anonymous identity.
• Client.ActivateUserName Method — Activates the session with a user name and password identity.
• Client.Begin Method — Sends a service request.
• Client.Close Method — Closes the session and the secure channel in an orderly way.
• Client.Connect Method — Opens a secure channel to a server and creates a session.
• Client.Discover Method — Requests the endpoints of a server without creating a session.
• Client.Dispose Method — Releases the client; an open connection is aborted without a protocol close.
• Client.Poll Method — Sends queued request data and reads the responses that have arrived, without waiting for new data.
• Client.Take Method — Takes the response to a request if it has arrived.
• ClientOptions.ClientOptions Constructor — Initializes a new instance with default values.
• License.HostId Method — Gets the host id of this machine, which host-bound licenses (SECS/GEM runtime licenses) name.
• License.Install Method — Installs license text, replacing text installed earlier through this method.
• License.Status Method — Gets the license status of the OPC UA library.
• Server.AddVariable Method — Adds a variable below the Objects folder.
• Server.Close Method — Stops accepting connections and aborts open channels.
• Server.Create Method — Creates a server and binds its listening socket.
• Server.Dispose Method — Releases the server, aborting open channels if it is still running.
• Server.LocalAddress Method — Gets the socket address the server is bound to, for example to learn the port chosen for port 0.
• Server.Poll Method — Accepts connections and serves pending requests without waiting for new data.
• Server.ReadValue Method — Reads the current value of a variable from the application.
• Server.SetValue Method — Sets the value of a variable from the application.
• ServerOptions.ServerOptions Constructor — Initializes a new instance with default values.
• OpcUa Namespace
• Client.AbiVersion Property — Gets the ABI version reported by the native library, as major in the upper 16 bits and minor in the lower 16 bits.
• ClientOptions.AllowNone Property — Gets whether SecurityPolicy.None may be used; it is rejected unless this is true.
• ClientOptions.ApplicationUri Property — Gets the client's application URI; default urn:pdcomm:opcua:client.
• ClientOptions.CertificateDer Property — Gets the client's application instance certificate, DER-encoded; empty for none.
• ClientOptions.Mode Property — Gets the message security mode; default SecurityMode.SignAndEncrypt.
• ClientOptions.Policy Property — Gets the security policy of the secure channel; default SecurityPolicy.Aes256Sha256RsaPss.
• ClientOptions.PrivateKeyPem Property — Gets the private key of ClientOptions.CertificateDer, PEM-encoded; empty for none.
• ClientOptions.TimeoutMs Property — Gets the timeout of each network exchange, in milliseconds; default 10000. DNS resolution is not covered.
• ClientOptions.TrustedServerDer Property — Gets the server certificate to trust explicitly, DER-encoded; empty for none.
• ClientOptions.UserSecretHeaderPolicyOnly Property — Gets whether new RSA-encrypted user secrets omit their outer encryption algorithm URI, so that the authenticated security header selects the policy. Set it only when the server requires it; legacy-format tokens still carry the algorithm URI.
• OpcUaException.LicenseRequired Property — Gets whether the call was refused because no valid PDComm license grants the module it needs (opcua-client for discovery and connect, opcua-server for server creation); native status 11.
• OpcUaException.NativeStatus Property — Gets the native status code: 1 invalid input, 2 invalid handle, 3 internal error, 4 buffer too small, 5 runtime error (for example a network, security or protocol failure), 7 busy, 8 poisoned, 9 limit exceeded, 10 closed, or 11 license required.
• Response.Info Property — Gets the response's request ID, encoding ID and service status.
• ServerOptions.AllowNone Property — Gets whether the server also offers an endpoint without security; default false.
• ServerOptions.ApplicationUri Property — Gets the server's application URI; default urn:pdcomm:opcua:server.
• ServerOptions.CertificateDer Property — Gets the server's application instance certificate, DER-encoded.
• ServerOptions.Endpoint Property — Gets the endpoint URL that the server advertises; default opc.tcp://localhost:4840/pdcomm. With port 0 the advertised endpoints use the port actually bound.
• ServerOptions.MaxConnections Property — Gets the largest number of concurrent TCP connections; default 33.
• ServerOptions.MaxSessions Property — Gets the largest number of concurrent sessions; default 32.
• ServerOptions.PrivateKeyPem Property — Gets the private key of ServerOptions.CertificateDer, PEM-encoded.
• ServerOptions.TrustedClientDer Property — Gets the one client certificate to trust explicitly, DER-encoded; empty for none.
• BinaryBuffer Class — An immutable byte buffer owned by the PDComm OPC UA native library.
• Client Class — An OPC UA client session driven by the caller: send UA Binary service requests and poll for their responses.
• ClientOptions Class — Security, identity and timing options for Client.Connect.
• License Class — Installs and inspects the PDComm license of the OPC UA native library.
• OpcUaException Class — The exception thrown when a PDComm OPC UA native call fails.
• Response Class — A validated OPC UA service response taken from a Client.
• ResponseInfo Struct — Metadata of a validated OPC UA service response.
• SecurityMode Enum — OPC UA message security modes (MessageSecurityMode).
• SecurityPolicy Enum — OPC UA security policies (OPC 10000-7) supported for the secure channel.
• Server Class — An OPC UA server with an in-memory address space, driven by the caller.
• ServerOptions Class — Endpoint, identity, trust and capacity options for Server.Create.
• VariableFlags Enum — Access options of a variable added with Server.AddVariable.