OPC UA C++ API

The public C++ API of OPC UA.

All kindsClassConstructorEnumEnumeratorEventFieldFunctionMethodNamespaceStructTypedef145 symbols

• opcua Namespace — OPC UA C++ API: RAII wrappers of the C ABI, plus the QtCore and MFC client workers.
• MfcClientConfiguration Struct — Connection and identity settings of an MfcClientWorker.
• MfcClientConfiguration::anonymous Field — Activate anonymously instead of with userName and userSecret.
• MfcClientConfiguration::applicationUri Field — ApplicationUri in UTF-8, at most 4096 bytes; must match the client certificate.
• MfcClientConfiguration::certificateDer Field — Client application instance certificate (DER, at most 64 KiB).
• MfcClientConfiguration::endpoint Field — opc.tcp:// endpoint URL in UTF-8, at most 4096 bytes.
• MfcClientConfiguration::flags Field — Bitwise OR of ::pdcomm_opcua_option_flags values.
• MfcClientConfiguration::mode Field — Requested ::pdcomm_opcua_security_mode value.
• MfcClientConfiguration::policy Field — Requested ::pdcomm_opcua_policy value.
• MfcClientConfiguration::privateKeyPem Field — Private key of that certificate (PEM, at most 64 KiB).
• MfcClientConfiguration::timeoutMs Field — Timeout of each network exchange and each outstanding request, 1 to 300000 ms.
• MfcClientConfiguration::trustedServerDer Field — Server certificate to trust (DER, at most 64 KiB).
• MfcClientConfiguration::userName Field — UTF-8 user name for a UserNameIdentityToken, at most 4096 bytes; used when anonymous is false.
• MfcClientConfiguration::userSecret Field — UTF-8 password, at most 16 KiB; used when anonymous is false.
• MfcClientEvent Struct — One event taken from the worker's mailbox with MfcClientWorker::Drain().
• MfcClientEvent::aborted Field — Stopped: the worker ended any other way; always !orderly.
• MfcClientEvent::accepted Field — Stopped: requests admitted by Submit().
• MfcClientEvent::completed Field — Stopped: requests that ended with a response or a begin or response failure.
• MfcClientEvent::correlation Field — Pending, Completed, Failed: correlation passed to MfcClientWorker::Submit(); 0 for a worker failure.
• MfcClientEvent::discarded Field — Stopped: requests that ended with an abort failure.
• MfcClientEvent::kind Field — Event kind.
• MfcClientEvent::metadata Field — Completed: request ID, encoding ID and serviceResult of the response.
• MfcClientEvent::orderly Field — Stopped: a drain finished with CloseSession and channel close.
• MfcClientEvent::ownerThread Field — Ready: Win32 thread ID of the worker thread that owns the native client.
• MfcClientEvent::phase Field — Failed: begin, response, abort or worker.
• MfcClientEvent::reason Field — Stopped: drained-and-closed, aborted, native-error or adapter-error.
• MfcClientEvent::requestId Field — Pending, Completed: native request ID (the requestHandle).
• MfcClientEvent::status Field — Failed: ::pdcomm_opcua_status value of the failure.
• MfcClientEvent::text Field — Failed: English detail text, copied in the worker thread right after the native call.
• MfcClientEvent::value 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 Enum — Kind of an MfcClientEvent; it selects which members are set.
• MfcClientEventKind::Completed Enumerator — A validated response arrived; correlation, requestId, metadata and value are set.
• MfcClientEventKind::Failed Enumerator — A request or the worker failed; correlation (0 for the worker), status, phase and text are set.
• MfcClientEventKind::Pending Enumerator — A request was sent; correlation and requestId are set.
• MfcClientEventKind::Ready Enumerator — The session is activated; ownerThread is set.
• MfcClientEventKind::Stopped Enumerator — The worker has ended; always the last event. orderly, aborted, the counters and reason are set.
• MfcClientStop Enum — How MfcClientWorker::RequestStop() ends the worker.
• MfcClientStop::Abort Enumerator — Stop at the next check, discard pending work and release the client without a protocol close.
• MfcClientStop::Drain Enumerator — Complete every admitted request, then close the session and channel.
• MfcClientWorker Class — One-shot MFC worker thread that owns a native OPC UA client.
• MfcClientWorker::Drain Method — Takes every queued event in order; call it on the receiver thread.
• MfcClientWorker::MaximumCommands Field — Maximum number of admitted requests that are queued or in flight.
• MfcClientWorker::MaximumEvents Field — Upper bound of the events that can wait in the mailbox at once.
• MfcClientWorker::MaximumQueuedBytes Field — Maximum size of one request and of all queued, unsent requests together (4 MiB).
• MfcClientWorker::MfcClientWorker Constructor — Creates a worker; Start() begins the connection.
• MfcClientWorker::MfcClientWorker Constructor — Copying is disabled.
• MfcClientWorker::RequestStop Method — Asks the worker to stop; thread-safe.
• MfcClientWorker::Start Method — Starts the worker thread; one-shot.
• MfcClientWorker::Submit Method — Queues one UA Binary service request; thread-safe.
• MfcClientWorker::Wait Method — Waits for the worker thread to exit; owner thread only.
• MfcClientWorker::operator= Method — Copy assignment is disabled.
• MfcClientWorker::~MfcClientWorker Method — Requests an abort, waits for the thread and wipes the credentials.
• buffer Class — Owned, immutable byte buffer returned by the library.
• buffer::buffer Constructor — Takes ownership of a buffer handle.
• buffer::copy Method — Copies the buffer contents.
• bytes Function — Borrows the bytes of a string as a ::pdcomm_opcua_bytes view.
• bytes Function — Borrows the bytes of a vector as a ::pdcomm_opcua_bytes view.
• check Function — Throws for a failed C ABI status.
• client Class — OPC UA client session over one secure channel.
• client::activate_anonymous Method — Activates the session anonymously (ActivateSession).
• client::activate_user_name Method — Activates the session with a user name and password (ActivateSession).
• client::begin Method — Queues one UA Binary service request.
• client::close Method — Closes the session and the secure channel in an orderly way.
• client::connect Method — Connects to a server and creates a session.
• client::discover Method — Reads the endpoints of a server without authentication.
• client::poll Method — Sends queued bytes and receives arrived responses without blocking.
• client::take Method — Takes the response of a request if it has arrived.
• error Class — Exception thrown by the wrapper for every failed C ABI call.
• error::error Constructor — Creates an exception.
• error::license_required Method — Tells whether the call was refused for lack of a PDComm license.
• error::status Method — Returns the status of the failed call.
• license Class — PDComm license of the OPC UA library: install license text, read the license status and this host id.
• license::host_id Method — Returns this host id, PDH1-XXXX-XXXX-XXXX-XXXX.
• license::install Method — Installs license text, replacing text installed earlier.
• license::status Method — Returns the license status JSON (see pdcomm_opcua_license_status()).
• options Function — Returns client options filled with the library defaults.
• owned Class — Move-only owner of one ::pdcomm_opcua_handle; base of every wrapper.
• owned::operator= Method — Copy assignment is disabled: a handle has exactly one owner.
• owned::operator= Method — Releases the current handle, then takes ownership from other.
• owned::owned Constructor — Creates an empty owner.
• owned::owned Constructor — Copying is disabled: a handle has exactly one owner.
• owned::owned Constructor — Moves ownership; other becomes empty.
• owned::reset Method — Releases the owned handle now and leaves the object empty.
• owned::~owned Method — Releases the owned handle, if any.
• qt_client_configuration Struct — Connection and identity settings of a qt_client_worker.
• qt_client_configuration::anonymous Field — Activate anonymously instead of with user_name and user_secret.
• qt_client_configuration::application_uri Field — ApplicationUri, at most 4096 bytes; must match the client certificate.
• qt_client_configuration::certificate_der Field — Client application instance certificate (DER, at most 64 KiB).
• qt_client_configuration::endpoint Field — opc.tcp:// endpoint URL in UTF-8, at most 4096 bytes.
• qt_client_configuration::flags Field — Bitwise OR of ::pdcomm_opcua_option_flags values.
• qt_client_configuration::mode Field — Requested ::pdcomm_opcua_security_mode value.
• qt_client_configuration::policy Field — Requested ::pdcomm_opcua_policy value.
• qt_client_configuration::private_key_pem Field — Private key of that certificate (PEM, at most 64 KiB).
• qt_client_configuration::timeout_ms Field — Timeout of each network exchange and each outstanding request, 1 to 300000 ms.
• qt_client_configuration::trusted_server_der Field — Server certificate to trust (DER, at most 64 KiB).
• qt_client_configuration::user_name Field — UTF-8 user name for a UserNameIdentityToken; used when anonymous is false.
• qt_client_configuration::user_secret Field — UTF-8 password, at most 16 KiB; used when anonymous is false.
• qt_client_failure Struct — A failure delivered by qt_client_worker::failed().
• qt_client_failure::correlation Field — Correlation of the failed request, or 0 for a worker failure.
• qt_client_failure::phase Field — "begin", "response", "abort" or "worker".
• qt_client_failure::status Field — ::pdcomm_opcua_status value of the failure.
• qt_client_failure::text Field — English detail text, copied in the worker thread right after the native call.
• qt_client_response Struct — A response delivered by qt_client_worker::completed().
• qt_client_response::correlation Field — Correlation that the application passed to qt_client_worker::submit().
• qt_client_response::metadata Field — Response metadata: request ID, encoding ID and serviceResult.
• qt_client_response::request_id Field — Native request ID (the requestHandle) of the request.
• qt_client_response::value 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 Typedef — Shared, immutable response passed by queued signals.
• qt_client_stop Enum — How qt_client_worker::request_stop() ends the worker.
• qt_client_stop::abort Enumerator — Stop at the next check, discard pending work and release the client without a protocol close.
• qt_client_stop::drain Enumerator — Complete every admitted request, then close the session and channel.
• qt_client_terminal Struct — Final report delivered by qt_client_worker::stopped().
• qt_client_terminal::aborted Field — True when the worker ended any other way; always !orderly.
• qt_client_terminal::accepted Field — Requests admitted by submit().
• qt_client_terminal::completed Field — Requests that ended with a response or a "begin" or "response" failure.
• qt_client_terminal::discarded Field — Requests that ended with an "abort" failure.
• qt_client_terminal::orderly Field — True when a drain finished with CloseSession and channel close.
• qt_client_terminal::reason Field — Why the worker ended: "drained-and-closed", "aborted", "native-error", "adapter-error" or "restart-rejected".
• qt_client_worker Class — One-shot QThread that owns a native OPC UA client.
• qt_client_worker::completed Event — A validated response arrived; the request has ended.
• qt_client_worker::failed Event — A request or the worker failed; see qt_client_failure.
• qt_client_worker::maximum_commands Field — Maximum number of admitted requests that are queued or in flight.
• qt_client_worker::maximum_queued_bytes Field — Maximum size of one request and of all queued, unsent requests together (4 MiB).
• qt_client_worker::operator= Method — Copy assignment is disabled.
• qt_client_worker::pending Event — A request was sent to the server.
• qt_client_worker::qt_client_worker Constructor — Copying is disabled.
• qt_client_worker::qt_client_worker Constructor — Creates a worker; start() begins the connection.
• qt_client_worker::ready Event — The session is activated and requests are being sent.
• qt_client_worker::request_stop Method — Asks the worker to stop; thread-safe.
• qt_client_worker::stopped Event — The worker has ended; always the last signal of a run.
• qt_client_worker::submit Method — Queues one UA Binary service request; thread-safe.
• qt_client_worker::~qt_client_worker Method — Requests an abort, waits for the thread and wipes the credentials.
• require_version Function — Checks that the loaded library implements ABI 0x00000002.
• response Class — Owned, validated UA Binary service response.
• response::info Method — Returns the response metadata.
• response::response Constructor — Takes ownership of a response handle.
• server Class — In-memory OPC UA server with variables in namespace 2.
• server::add_variable Method — Adds a Variable node below the Objects folder.
• server::close Method — Closes the listener and aborts every channel.
• server::create Method — Creates and binds a server.
• server::local_address Method — Returns the socket address the server listens on.
• server::poll Method — Accepts connections and processes requests once, without blocking.
• server::read_value Method — Reads the Value attribute as a local, authenticated user.
• server::set_value Method — Writes the Value attribute as a local, authenticated user.
• server_options Function — Returns server options filled with the library defaults.