OPC UA API reference

• C 87 symbols
• C++ 145 symbols
• .NET 71 symbols

AllCC++.NETAll kindsClassConstructorEnumEnumeratorEventFieldFunctionMethodNamespacePropertyStructTypedef303 symbols

• PDCOMM_OPCUA_AES128SHA256RSAOAEP C Enumerator — http://opcfoundation.org/UA/SecurityPolicy#Aes128_Sha256_RsaOaep.
• PDCOMM_OPCUA_AES256SHA256RSAPSS C Enumerator — http://opcfoundation.org/UA/SecurityPolicy#Aes256_Sha256_RsaPss (default).
• PDCOMM_OPCUA_ALLOW_NONE C Enumerator — Allows SecurityPolicy None. Without it the client rejects #PDCOMM_OPCUA_POLICY_NONE and the server advertises secure endpoints only.
• PDCOMM_OPCUA_BASIC256SHA256 C Enumerator — http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256.
• PDCOMM_OPCUA_BUFFER_TOO_SMALL C Enumerator — The output is too small; the required size is reported and the output is unchanged.
• PDCOMM_OPCUA_BUSY C Enumerator — The handle is in use by another thread, requests are outstanding, or a response is held for pdcomm_opcua_client_take_response().
• PDCOMM_OPCUA_CLOSED C Enumerator — The client or server is closed or has failed; release it.
• PDCOMM_OPCUA_EMPTY C Enumerator — The requested response has not arrived yet; poll and try again.
• PDCOMM_OPCUA_INTERNAL_ERROR C Enumerator — An internal failure, such as a contained panic; see pdcomm_opcua_last_error_copy().
• PDCOMM_OPCUA_INVALID_HANDLE C Enumerator — The handle is zero, released, unknown or of the wrong kind.
• PDCOMM_OPCUA_INVALID_INPUT C Enumerator — An argument, size, structure version or encoding is invalid, or a request ID is unknown.
• PDCOMM_OPCUA_LICENSE_REQUIRED C Enumerator — No valid PDComm license grants the module this call needs (opcua-client or opcua-server), so nothing was started. The detail text names the module and the license state, such as missing, expired or updates-expired. Added in ABI 0.2.
• PDCOMM_OPCUA_LIMIT C Enumerator — A resource limit was reached; the request was not sent or the handle was not created.
• PDCOMM_OPCUA_MODE_NONE C Enumerator — None: only valid with #PDCOMM_OPCUA_POLICY_NONE.
• PDCOMM_OPCUA_OK C Enumerator — The call succeeded.
• PDCOMM_OPCUA_POISONED C Enumerator — A previous call panicked; the handle is invalid and may only be released.
• PDCOMM_OPCUA_POLICY_NONE C Enumerator — http://opcfoundation.org/UA/SecurityPolicy#None: no signing or encryption. Requires #PDCOMM_OPCUA_MODE_NONE and #PDCOMM_OPCUA_ALLOW_NONE.
• PDCOMM_OPCUA_RUNTIME_ERROR C Enumerator — A network, security, protocol or address-space failure, including a timeout or an invalid response. The detail text names the cause.
• PDCOMM_OPCUA_SIGN C Enumerator — Sign: messages are signed but not encrypted.
• PDCOMM_OPCUA_SIGN_AND_ENCRYPT C Enumerator — SignAndEncrypt: messages are signed and encrypted (default).
• PDCOMM_OPCUA_USER_SECRET_HEADER_POLICY_ONLY C Enumerator — Client only: for user secrets longer than 64 bytes, which are sent as an RSA EncryptedSecret, leave the token's encryptionAlgorithm empty so that the SecurityPolicy in the secret's header alone selects the algorithms. Set it only when the server expects this form. Shorter secrets use the legacy encrypted token and always carry the algorithm URI.
• PDCOMM_OPCUA_VARIABLE_PUBLIC C Enumerator — Anonymous sessions may access the variable. Without this flag only authenticated users may read or write it, and anonymous sessions get BadUserAccessDenied.
• PDCOMM_OPCUA_VARIABLE_WRITABLE C Enumerator — Clients may write the Value attribute (AccessLevel CurrentWrite).
• pdcomm_opcua_abi_version C Function — Returns the ABI version of the loaded library.
• pdcomm_opcua_buffer_copy C Function — Copies the bytes of a buffer handle.
• pdcomm_opcua_bytes C Struct — A borrowed byte range: UTF-8 text or binary data without a terminator.
• data C Field — First byte of the range, or null for an empty range.
• size C Field — Number of bytes in the range.
• pdcomm_opcua_client_activate_anonymous C Function — Activates the session with an AnonymousIdentityToken (ActivateSession).
• pdcomm_opcua_client_activate_user_name C Function — Activates the session with a UserNameIdentityToken (ActivateSession).
• pdcomm_opcua_client_begin C Function — Queues one UA Binary service request without waiting for its response.
• pdcomm_opcua_client_close C Function — Closes the session and the secure channel in an orderly way.
• pdcomm_opcua_client_connect C Function — Connects a client and creates a session.
• pdcomm_opcua_client_options C Struct — Client connection options (structure version 1).
• application_uri C Field — ApplicationUri, at most 4096 bytes; empty means urn:pdcomm:opcua:client.
• certificate_der C Field — Client application instance certificate (DER, at most 64 KiB); required unless the policy is None.
• flags C Field — Bitwise OR of ::pdcomm_opcua_option_flags values.
• mode C Field — Requested ::pdcomm_opcua_security_mode value.
• policy C Field — Requested ::pdcomm_opcua_policy value.
• private_key_pem C Field — Private key of that certificate (PEM, at most 64 KiB).
• struct_size C Field — Size of this structure in bytes as known by the caller.
• timeout_ms C Field — Timeout of each network exchange and of each outstanding request, 1 to 300000 ms.
• trusted_server_der C Field — Server certificate to trust (DER, at most 64 KiB); the only trust anchor of this client.
• version C Field — Structure version; must be 1.
• pdcomm_opcua_client_options_init C Function — Fills client options with the defaults.
• pdcomm_opcua_client_poll C Function — Performs one non-blocking I/O pass: sends queued bytes and receives arrived responses.
• pdcomm_opcua_client_take_response C Function — Takes the validated response of one request.
• pdcomm_opcua_discover C Function — Reads the endpoints of a server (GetEndpoints).
• pdcomm_opcua_handle C Typedef — Opaque, library-local handle of a client, a server or a buffer.
• pdcomm_opcua_last_error_copy C Function — Copies the detail text of the last failed call on this thread.
• pdcomm_opcua_license_host_id C Function — Copies the host id of this machine, PDH1-XXXX-XXXX-XXXX-XXXX.
• pdcomm_opcua_license_install C Function — Installs PDComm license text for this library.
• pdcomm_opcua_license_status C Function — Copies the license status of this library as UTF-8 JSON.
• pdcomm_opcua_option_flags C Enum — Bits of the flags member of the client and server options.
• pdcomm_opcua_policy C Enum — SecurityPolicy of the secure channel that the client requests.
• pdcomm_opcua_release C Function — Releases a client, server or buffer handle.
• pdcomm_opcua_response_get_info C Function — Reads the metadata of a response buffer.
• pdcomm_opcua_response_info C Struct — Metadata of a validated service response (structure version 1).
• binary_id C Field — Numeric namespace 0 encoding ID of the body, such as 634 for ReadResponse or 397 for ServiceFault.
• request_id C Field — ID that pdcomm_opcua_client_begin() returned; equals the ResponseHeader requestHandle.
• reserved C Field — Written as zero.
• service_status C Field — ResponseHeader serviceResult; Bad only for a ServiceFault.
• struct_size C Field — In: size known by the caller.
• version C Field — In and out: structure version 1.
• pdcomm_opcua_security_mode C Enum — MessageSecurityMode of the secure channel, with the numeric values of the Part 4 MessageSecurityMode enumeration.
• pdcomm_opcua_server_add_variable C Function — Adds a Variable node below the Objects folder.
• pdcomm_opcua_server_close C Function — Stops the server: closes the listener and aborts every channel.
• pdcomm_opcua_server_create C Function — Creates and binds an in-memory OPC UA server.
• pdcomm_opcua_server_local_address C Function — Returns the socket address the server listens on.
• pdcomm_opcua_server_options C Struct — Server options of the in-memory server facade (structure version 1).
• application_uri C Field — ApplicationUri, at most 4096 bytes; empty means urn:pdcomm:opcua:server.
• certificate_der C Field — Server application instance certificate (DER, at most 64 KiB); required unless #PDCOMM_OPCUA_ALLOW_NONE is set.
• endpoint C Field — Endpoint URL advertised to clients (opc.tcp://host:port/path, at most 4096 bytes); port 0 is replaced by the actual listening port.
• flags C Field — 0 or #PDCOMM_OPCUA_ALLOW_NONE.
• max_connections C Field — Concurrent secure channels: more than max_sessions and at most 1024 (default 33).
• max_sessions C Field — Concurrent sessions, 1 to 1023 (default 32).
• private_key_pem C Field — Private key of that certificate (PEM, at most 64 KiB).
• reserved C Field — Must be zero.
• struct_size C Field — Size of this structure in bytes as known by the caller.
• trusted_client_der C Field — The one client certificate this server trusts (DER, at most 64 KiB).
• version C Field — Structure version; must be 1.
• pdcomm_opcua_server_options_init C Function — Fills server options with the defaults.
• pdcomm_opcua_server_poll C Function — Performs one non-blocking server pass: accepts connections and processes received requests and subscriptions.
• pdcomm_opcua_server_read_value C Function — Reads the Value attribute of a node as a local, authenticated user.
• pdcomm_opcua_server_set_value C Function — Writes the Value attribute of a variable as a local, authenticated user.
• pdcomm_opcua_status C Enum — Status code returned by every int32_t OPC UA C ABI function.
• pdcomm_opcua_variable_flags C Enum — Flags of pdcomm_opcua_server_add_variable().
• opcua C++ Namespace — OPC UA C++ API: RAII wrappers of the C ABI, plus the QtCore and MFC client workers.
• MfcClientConfiguration C++ Struct — Connection and identity settings of an MfcClientWorker.
• MfcClientConfiguration::anonymous C++ Field — Activate anonymously instead of with userName and userSecret.
• MfcClientConfiguration::applicationUri C++ Field — ApplicationUri in UTF-8, at most 4096 bytes; must match the client certificate.
• MfcClientConfiguration::certificateDer C++ Field — Client application instance certificate (DER, at most 64 KiB).
• MfcClientConfiguration::endpoint C++ Field — opc.tcp:// endpoint URL in UTF-8, at most 4096 bytes.
• MfcClientConfiguration::flags C++ Field — Bitwise OR of ::pdcomm_opcua_option_flags values.
• MfcClientConfiguration::mode C++ Field — Requested ::pdcomm_opcua_security_mode value.
• MfcClientConfiguration::policy C++ Field — Requested ::pdcomm_opcua_policy value.
• MfcClientConfiguration::privateKeyPem C++ Field — Private key of that certificate (PEM, at most 64 KiB).
• MfcClientConfiguration::timeoutMs C++ Field — Timeout of each network exchange and each outstanding request, 1 to 300000 ms.
• MfcClientConfiguration::trustedServerDer C++ Field — Server certificate to trust (DER, at most 64 KiB).
• MfcClientConfiguration::userName C++ Field — UTF-8 user name for a UserNameIdentityToken, at most 4096 bytes; used when anonymous is false.
• MfcClientConfiguration::userSecret C++ Field — UTF-8 password, at most 16 KiB; used when anonymous is false.
• MfcClientEvent C++ Struct — One event taken from the worker's mailbox with MfcClientWorker::Drain().
• MfcClientEvent::aborted C++ Field — Stopped: the worker ended any other way; always !orderly.
• MfcClientEvent::accepted C++ Field — Stopped: requests admitted by Submit().
• MfcClientEvent::completed C++ Field — Stopped: requests that ended with a response or a begin or response failure.
• MfcClientEvent::correlation C++ Field — Pending, Completed, Failed: correlation passed to MfcClientWorker::Submit(); 0 for a worker failure.
• MfcClientEvent::discarded C++ Field — Stopped: requests that ended with an abort failure.
• MfcClientEvent::kind C++ Field — Event kind.
• MfcClientEvent::metadata C++ Field — Completed: request ID, encoding ID and serviceResult of the response.
• MfcClientEvent::orderly C++ Field — Stopped: a drain finished with CloseSession and channel close.
• MfcClientEvent::ownerThread C++ Field — Ready: Win32 thread ID of the worker thread that owns the native client.
• MfcClientEvent::phase C++ Field — Failed: begin, response, abort or worker.
• MfcClientEvent::reason C++ Field — Stopped: drained-and-closed, aborted, native-error or adapter-error.
• MfcClientEvent::requestId C++ Field — Pending, Completed: native request ID (the requestHandle).
• MfcClientEvent::status C++ Field — Failed: ::pdcomm_opcua_status value of the failure.
• MfcClientEvent::text C++ Field — Failed: English detail text, copied in the worker thread right after the native call.
• MfcClientEvent::value C++ Field — Completed: the owned response, possibly a ServiceFault. It survives the client and the worker and holds a native handle until the last reference is gone.
• MfcClientEventKind C++ Enum — Kind of an MfcClientEvent; it selects which members are set.
• MfcClientEventKind::Completed C++ Enumerator — A validated response arrived; correlation, requestId, metadata and value are set.
• MfcClientEventKind::Failed C++ Enumerator — A request or the worker failed; correlation (0 for the worker), status, phase and text are set.
• MfcClientEventKind::Pending C++ Enumerator — A request was sent; correlation and requestId are set.
• MfcClientEventKind::Ready C++ Enumerator — The session is activated; ownerThread is set.
• MfcClientEventKind::Stopped C++ Enumerator — The worker has ended; always the last event. orderly, aborted, the counters and reason are set.
• MfcClientStop C++ Enum — How MfcClientWorker::RequestStop() ends the worker.
• MfcClientStop::Abort C++ Enumerator — Stop at the next check, discard pending work and release the client without a protocol close.
• MfcClientStop::Drain C++ Enumerator — Complete every admitted request, then close the session and channel.
• MfcClientWorker C++ Class — One-shot MFC worker thread that owns a native OPC UA client.
• MfcClientWorker::Drain C++ Method — Takes every queued event in order; call it on the receiver thread.
• MfcClientWorker::MaximumCommands C++ Field — Maximum number of admitted requests that are queued or in flight.
• MfcClientWorker::MaximumEvents C++ Field — Upper bound of the events that can wait in the mailbox at once.
• MfcClientWorker::MaximumQueuedBytes C++ Field — Maximum size of one request and of all queued, unsent requests together (4 MiB).
• MfcClientWorker::MfcClientWorker C++ Constructor — Creates a worker; Start() begins the connection.
• MfcClientWorker::MfcClientWorker C++ Constructor — Copying is disabled.
• MfcClientWorker::RequestStop C++ Method — Asks the worker to stop; thread-safe.
• MfcClientWorker::Start C++ Method — Starts the worker thread; one-shot.
• MfcClientWorker::Submit C++ Method — Queues one UA Binary service request; thread-safe.
• MfcClientWorker::Wait C++ Method — Waits for the worker thread to exit; owner thread only.
• MfcClientWorker::operator= C++ Method — Copy assignment is disabled.
• MfcClientWorker::~MfcClientWorker C++ Method — Requests an abort, waits for the thread and wipes the credentials.
• buffer C++ Class — Owned, immutable byte buffer returned by the library.
• buffer::buffer C++ Constructor — Takes ownership of a buffer handle.
• buffer::copy C++ Method — Copies the buffer contents.
• bytes C++ Function — Borrows the bytes of a string as a ::pdcomm_opcua_bytes view.
• bytes C++ Function — Borrows the bytes of a vector as a ::pdcomm_opcua_bytes view.
• check C++ Function — Throws for a failed C ABI status.
• client C++ Class — OPC UA client session over one secure channel.
• client::activate_anonymous C++ Method — Activates the session anonymously (ActivateSession).
• client::activate_user_name C++ Method — Activates the session with a user name and password (ActivateSession).
• client::begin C++ Method — Queues one UA Binary service request.
• client::close C++ Method — Closes the session and the secure channel in an orderly way.
• client::connect C++ Method — Connects to a server and creates a session.
• client::discover C++ Method — Reads the endpoints of a server without authentication.
• client::poll C++ Method — Sends queued bytes and receives arrived responses without blocking.
• client::take C++ Method — Takes the response of a request if it has arrived.
• error C++ Class — Exception thrown by the wrapper for every failed C ABI call.
• error::error C++ Constructor — Creates an exception.
• error::license_required C++ Method — Tells whether the call was refused for lack of a PDComm license.
• error::status C++ Method — Returns the status of the failed call.
• license C++ Class — PDComm license of the OPC UA library: install license text, read the license status and this host id.
• license::host_id C++ Method — Returns this host id, PDH1-XXXX-XXXX-XXXX-XXXX.
• license::install C++ Method — Installs license text, replacing text installed earlier.
• license::status C++ Method — Returns the license status JSON (see pdcomm_opcua_license_status()).
• options C++ Function — Returns client options filled with the library defaults.
• owned C++ Class — Move-only owner of one ::pdcomm_opcua_handle; base of every wrapper.
• owned::operator= C++ Method — Copy assignment is disabled: a handle has exactly one owner.
• owned::operator= C++ Method — Releases the current handle, then takes ownership from other.
• owned::owned C++ Constructor — Creates an empty owner.
• owned::owned C++ Constructor — Copying is disabled: a handle has exactly one owner.
• owned::owned C++ Constructor — Moves ownership; other becomes empty.
• owned::reset C++ Method — Releases the owned handle now and leaves the object empty.
• owned::~owned C++ Method — Releases the owned handle, if any.
• qt_client_configuration C++ Struct — Connection and identity settings of a qt_client_worker.
• qt_client_configuration::anonymous C++ Field — Activate anonymously instead of with user_name and user_secret.
• qt_client_configuration::application_uri C++ Field — ApplicationUri, at most 4096 bytes; must match the client certificate.
• qt_client_configuration::certificate_der C++ Field — Client application instance certificate (DER, at most 64 KiB).
• qt_client_configuration::endpoint C++ Field — opc.tcp:// endpoint URL in UTF-8, at most 4096 bytes.
• qt_client_configuration::flags C++ Field — Bitwise OR of ::pdcomm_opcua_option_flags values.
• qt_client_configuration::mode C++ Field — Requested ::pdcomm_opcua_security_mode value.
• qt_client_configuration::policy C++ Field — Requested ::pdcomm_opcua_policy value.
• qt_client_configuration::private_key_pem C++ Field — Private key of that certificate (PEM, at most 64 KiB).
• qt_client_configuration::timeout_ms C++ Field — Timeout of each network exchange and each outstanding request, 1 to 300000 ms.
• qt_client_configuration::trusted_server_der C++ Field — Server certificate to trust (DER, at most 64 KiB).
• qt_client_configuration::user_name C++ Field — UTF-8 user name for a UserNameIdentityToken; used when anonymous is false.
• qt_client_configuration::user_secret C++ Field — UTF-8 password, at most 16 KiB; used when anonymous is false.
• qt_client_failure C++ Struct — A failure delivered by qt_client_worker::failed().
• qt_client_failure::correlation C++ Field — Correlation of the failed request, or 0 for a worker failure.
• qt_client_failure::phase C++ Field — "begin", "response", "abort" or "worker".
• qt_client_failure::status C++ Field — ::pdcomm_opcua_status value of the failure.
• qt_client_failure::text C++ Field — English detail text, copied in the worker thread right after the native call.
• qt_client_response C++ Struct — A response delivered by qt_client_worker::completed().
• qt_client_response::correlation C++ Field — Correlation that the application passed to qt_client_worker::submit().
• qt_client_response::metadata C++ Field — Response metadata: request ID, encoding ID and serviceResult.
• qt_client_response::request_id C++ Field — Native request ID (the requestHandle) of the request.
• qt_client_response::value C++ Field — The owned response. It survives the client and the worker; its const copy() and info() may be called from any thread, and the native buffer is released with the last reference.
• qt_client_response_ptr C++ Typedef — Shared, immutable response passed by queued signals.
• qt_client_stop C++ Enum — How qt_client_worker::request_stop() ends the worker.
• qt_client_stop::abort C++ Enumerator — Stop at the next check, discard pending work and release the client without a protocol close.
• qt_client_stop::drain C++ Enumerator — Complete every admitted request, then close the session and channel.
• qt_client_terminal C++ Struct — Final report delivered by qt_client_worker::stopped().
• qt_client_terminal::aborted C++ Field — True when the worker ended any other way; always !orderly.
• qt_client_terminal::accepted C++ Field — Requests admitted by submit().
• qt_client_terminal::completed C++ Field — Requests that ended with a response or a "begin" or "response" failure.
• qt_client_terminal::discarded C++ Field — Requests that ended with an "abort" failure.
• qt_client_terminal::orderly C++ Field — True when a drain finished with CloseSession and channel close.
• qt_client_terminal::reason C++ Field — Why the worker ended: "drained-and-closed", "aborted", "native-error", "adapter-error" or "restart-rejected".
• qt_client_worker C++ Class — One-shot QThread that owns a native OPC UA client.
• qt_client_worker::completed C++ Event — A validated response arrived; the request has ended.
• qt_client_worker::failed C++ Event — A request or the worker failed; see qt_client_failure.
• qt_client_worker::maximum_commands C++ Field — Maximum number of admitted requests that are queued or in flight.
• qt_client_worker::maximum_queued_bytes C++ Field — Maximum size of one request and of all queued, unsent requests together (4 MiB).
• qt_client_worker::operator= C++ Method — Copy assignment is disabled.
• qt_client_worker::pending C++ Event — A request was sent to the server.
• qt_client_worker::qt_client_worker C++ Constructor — Copying is disabled.
• qt_client_worker::qt_client_worker C++ Constructor — Creates a worker; start() begins the connection.
• qt_client_worker::ready C++ Event — The session is activated and requests are being sent.
• qt_client_worker::request_stop C++ Method — Asks the worker to stop; thread-safe.
• qt_client_worker::stopped C++ Event — The worker has ended; always the last signal of a run.
• qt_client_worker::submit C++ Method — Queues one UA Binary service request; thread-safe.
• qt_client_worker::~qt_client_worker C++ Method — Requests an abort, waits for the thread and wipes the credentials.
• require_version C++ Function — Checks that the loaded library implements ABI 0x00000002.
• response C++ Class — Owned, validated UA Binary service response.
• response::info C++ Method — Returns the response metadata.
• response::response C++ Constructor — Takes ownership of a response handle.
• server C++ Class — In-memory OPC UA server with variables in namespace 2.
• server::add_variable C++ Method — Adds a Variable node below the Objects folder.
• server::close C++ Method — Closes the listener and aborts every channel.
• server::create C++ Method — Creates and binds a server.
• server::local_address C++ Method — Returns the socket address the server listens on.
• server::poll C++ Method — Accepts connections and processes requests once, without blocking.
• server::read_value C++ Method — Reads the Value attribute as a local, authenticated user.
• server::set_value C++ Method — Writes the Value attribute as a local, authenticated user.
• server_options C++ Function — Returns server options filled with the library defaults.
• ResponseInfo.BinaryId .NET Field — The numeric binary encoding ID (namespace 0) of the response body: the expected response type, or ServiceFault.
• ResponseInfo.RequestId .NET Field — The client-local request ID returned by Client.Begin.
• ResponseInfo.ServiceStatus .NET Field — The serviceResult status code from the response header; a Bad code has the top bit (0x80000000) set.
• SecurityMode.None .NET Enumerator — Messages are neither signed nor encrypted; only valid with SecurityPolicy.None.
• SecurityMode.Sign .NET Enumerator — Messages are signed.
• SecurityMode.SignAndEncrypt .NET Enumerator — Messages are signed and encrypted; the default.
• SecurityPolicy.Aes128Sha256RsaOaep .NET Enumerator — The Aes128_Sha256_RsaOaep policy.
• SecurityPolicy.Aes256Sha256RsaPss .NET Enumerator — The Aes256_Sha256_RsaPss policy; the default.
• SecurityPolicy.Basic256Sha256 .NET Enumerator — The Basic256Sha256 policy.
• SecurityPolicy.None .NET Enumerator — No security (http://opcfoundation.org/UA/SecurityPolicy#None); requires explicit opt-in.
• VariableFlags.None .NET Enumerator — Read-only, and readable only by authenticated (non-anonymous) sessions.
• VariableFlags.Public .NET Enumerator — Anonymous sessions may access the variable as well.
• VariableFlags.Writable .NET Enumerator — Clients may write the value.
• BinaryBuffer.Copy .NET Method — Copies the buffer's contents into a new array.
• BinaryBuffer.Dispose .NET Method — Releases the native buffer.
• Client.ActivateAnonymous .NET Method — Activates the session with an anonymous identity.
• Client.ActivateUserName .NET Method — Activates the session with a user name and password identity.
• Client.Begin .NET Method — Sends a service request.
• Client.Close .NET Method — Closes the session and the secure channel in an orderly way.
• Client.Connect .NET Method — Opens a secure channel to a server and creates a session.
• Client.Discover .NET Method — Requests the endpoints of a server without creating a session.
• Client.Dispose .NET Method — Releases the client; an open connection is aborted without a protocol close.
• Client.Poll .NET Method — Sends queued request data and reads the responses that have arrived, without waiting for new data.
• Client.Take .NET Method — Takes the response to a request if it has arrived.
• ClientOptions.ClientOptions .NET Constructor — Initializes a new instance with default values.
• License.HostId .NET Method — Gets the host id of this machine, which host-bound licenses (SECS/GEM runtime licenses) name.
• License.Install .NET Method — Installs license text, replacing text installed earlier through this method.
• License.Status .NET Method — Gets the license status of the OPC UA library.
• Server.AddVariable .NET Method — Adds a variable below the Objects folder.
• Server.Close .NET Method — Stops accepting connections and aborts open channels.
• Server.Create .NET Method — Creates a server and binds its listening socket.
• Server.Dispose .NET Method — Releases the server, aborting open channels if it is still running.
• Server.LocalAddress .NET Method — Gets the socket address the server is bound to, for example to learn the port chosen for port 0.
• Server.Poll .NET Method — Accepts connections and serves pending requests without waiting for new data.
• Server.ReadValue .NET Method — Reads the current value of a variable from the application.
• Server.SetValue .NET Method — Sets the value of a variable from the application.
• ServerOptions.ServerOptions .NET Constructor — Initializes a new instance with default values.
• OpcUa .NET Namespace
• Client.AbiVersion .NET 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 .NET Property — Gets whether SecurityPolicy.None may be used; it is rejected unless this is true.
• ClientOptions.ApplicationUri .NET Property — Gets the client's application URI; default urn:pdcomm:opcua:client.
• ClientOptions.CertificateDer .NET Property — Gets the client's application instance certificate, DER-encoded; empty for none.
• ClientOptions.Mode .NET Property — Gets the message security mode; default SecurityMode.SignAndEncrypt.
• ClientOptions.Policy .NET Property — Gets the security policy of the secure channel; default SecurityPolicy.Aes256Sha256RsaPss.
• ClientOptions.PrivateKeyPem .NET Property — Gets the private key of ClientOptions.CertificateDer, PEM-encoded; empty for none.
• ClientOptions.TimeoutMs .NET Property — Gets the timeout of each network exchange, in milliseconds; default 10000. DNS resolution is not covered.
• ClientOptions.TrustedServerDer .NET Property — Gets the server certificate to trust explicitly, DER-encoded; empty for none.
• ClientOptions.UserSecretHeaderPolicyOnly .NET 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 .NET 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 .NET 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 .NET Property — Gets the response's request ID, encoding ID and service status.
• ServerOptions.AllowNone .NET Property — Gets whether the server also offers an endpoint without security; default false.
• ServerOptions.ApplicationUri .NET Property — Gets the server's application URI; default urn:pdcomm:opcua:server.
• ServerOptions.CertificateDer .NET Property — Gets the server's application instance certificate, DER-encoded.
• ServerOptions.Endpoint .NET 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 .NET Property — Gets the largest number of concurrent TCP connections; default 33.
• ServerOptions.MaxSessions .NET Property — Gets the largest number of concurrent sessions; default 32.
• ServerOptions.PrivateKeyPem .NET Property — Gets the private key of ServerOptions.CertificateDer, PEM-encoded.
• ServerOptions.TrustedClientDer .NET Property — Gets the one client certificate to trust explicitly, DER-encoded; empty for none.
• BinaryBuffer .NET Class — An immutable byte buffer owned by the PDComm OPC UA native library.
• Client .NET Class — An OPC UA client session driven by the caller: send UA Binary service requests and poll for their responses.
• ClientOptions .NET Class — Security, identity and timing options for Client.Connect.
• License .NET Class — Installs and inspects the PDComm license of the OPC UA native library.
• OpcUaException .NET Class — The exception thrown when a PDComm OPC UA native call fails.
• Response .NET Class — A validated OPC UA service response taken from a Client.
• ResponseInfo .NET Struct — Metadata of a validated OPC UA service response.
• SecurityMode .NET Enum — OPC UA message security modes (MessageSecurityMode).
• SecurityPolicy .NET Enum — OPC UA security policies (OPC 10000-7) supported for the secure channel.
• Server .NET Class — An OPC UA server with an in-memory address space, driven by the caller.
• ServerOptions .NET Class — Endpoint, identity, trust and capacity options for Server.Create.
• VariableFlags .NET Enum — Access options of a variable added with Server.AddVariable.