OPC UA C API

The public C API of OPC UA.

All kindsEnumEnumeratorFieldFunctionStructTypedef87 symbols

• PDCOMM_OPCUA_AES128SHA256RSAOAEP Enumerator — http://opcfoundation.org/UA/SecurityPolicy#Aes128_Sha256_RsaOaep.
• PDCOMM_OPCUA_AES256SHA256RSAPSS Enumerator — http://opcfoundation.org/UA/SecurityPolicy#Aes256_Sha256_RsaPss (default).
• PDCOMM_OPCUA_ALLOW_NONE Enumerator — Allows SecurityPolicy None. Without it the client rejects #PDCOMM_OPCUA_POLICY_NONE and the server advertises secure endpoints only.
• PDCOMM_OPCUA_BASIC256SHA256 Enumerator — http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256.
• PDCOMM_OPCUA_BUFFER_TOO_SMALL Enumerator — The output is too small; the required size is reported and the output is unchanged.
• PDCOMM_OPCUA_BUSY 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 Enumerator — The client or server is closed or has failed; release it.
• PDCOMM_OPCUA_EMPTY Enumerator — The requested response has not arrived yet; poll and try again.
• PDCOMM_OPCUA_INTERNAL_ERROR Enumerator — An internal failure, such as a contained panic; see pdcomm_opcua_last_error_copy().
• PDCOMM_OPCUA_INVALID_HANDLE Enumerator — The handle is zero, released, unknown or of the wrong kind.
• PDCOMM_OPCUA_INVALID_INPUT Enumerator — An argument, size, structure version or encoding is invalid, or a request ID is unknown.
• PDCOMM_OPCUA_LICENSE_REQUIRED 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 Enumerator — A resource limit was reached; the request was not sent or the handle was not created.
• PDCOMM_OPCUA_MODE_NONE Enumerator — None: only valid with #PDCOMM_OPCUA_POLICY_NONE.
• PDCOMM_OPCUA_OK Enumerator — The call succeeded.
• PDCOMM_OPCUA_POISONED Enumerator — A previous call panicked; the handle is invalid and may only be released.
• PDCOMM_OPCUA_POLICY_NONE 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 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 Enumerator — Sign: messages are signed but not encrypted.
• PDCOMM_OPCUA_SIGN_AND_ENCRYPT Enumerator — SignAndEncrypt: messages are signed and encrypted (default).
• PDCOMM_OPCUA_USER_SECRET_HEADER_POLICY_ONLY 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 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 Enumerator — Clients may write the Value attribute (AccessLevel CurrentWrite).
• pdcomm_opcua_abi_version Function — Returns the ABI version of the loaded library.
• pdcomm_opcua_buffer_copy Function — Copies the bytes of a buffer handle.
• pdcomm_opcua_bytes Struct — A borrowed byte range: UTF-8 text or binary data without a terminator.
• data Field — First byte of the range, or null for an empty range.
• size Field — Number of bytes in the range.
• pdcomm_opcua_client_activate_anonymous Function — Activates the session with an AnonymousIdentityToken (ActivateSession).
• pdcomm_opcua_client_activate_user_name Function — Activates the session with a UserNameIdentityToken (ActivateSession).
• pdcomm_opcua_client_begin Function — Queues one UA Binary service request without waiting for its response.
• pdcomm_opcua_client_close Function — Closes the session and the secure channel in an orderly way.
• pdcomm_opcua_client_connect Function — Connects a client and creates a session.
• pdcomm_opcua_client_options Struct — Client connection options (structure version 1).
• application_uri Field — ApplicationUri, at most 4096 bytes; empty means urn:pdcomm:opcua:client.
• certificate_der Field — Client application instance certificate (DER, at most 64 KiB); required unless the policy is None.
• flags Field — Bitwise OR of ::pdcomm_opcua_option_flags values.
• mode Field — Requested ::pdcomm_opcua_security_mode value.
• policy Field — Requested ::pdcomm_opcua_policy value.
• private_key_pem Field — Private key of that certificate (PEM, at most 64 KiB).
• struct_size Field — Size of this structure in bytes as known by the caller.
• timeout_ms Field — Timeout of each network exchange and of each outstanding request, 1 to 300000 ms.
• trusted_server_der Field — Server certificate to trust (DER, at most 64 KiB); the only trust anchor of this client.
• version Field — Structure version; must be 1.
• pdcomm_opcua_client_options_init Function — Fills client options with the defaults.
• pdcomm_opcua_client_poll Function — Performs one non-blocking I/O pass: sends queued bytes and receives arrived responses.
• pdcomm_opcua_client_take_response Function — Takes the validated response of one request.
• pdcomm_opcua_discover Function — Reads the endpoints of a server (GetEndpoints).
• pdcomm_opcua_handle Typedef — Opaque, library-local handle of a client, a server or a buffer.
• pdcomm_opcua_last_error_copy Function — Copies the detail text of the last failed call on this thread.
• pdcomm_opcua_license_host_id Function — Copies the host id of this machine, PDH1-XXXX-XXXX-XXXX-XXXX.
• pdcomm_opcua_license_install Function — Installs PDComm license text for this library.
• pdcomm_opcua_license_status Function — Copies the license status of this library as UTF-8 JSON.
• pdcomm_opcua_option_flags Enum — Bits of the flags member of the client and server options.
• pdcomm_opcua_policy Enum — SecurityPolicy of the secure channel that the client requests.
• pdcomm_opcua_release Function — Releases a client, server or buffer handle.
• pdcomm_opcua_response_get_info Function — Reads the metadata of a response buffer.
• pdcomm_opcua_response_info Struct — Metadata of a validated service response (structure version 1).
• binary_id Field — Numeric namespace 0 encoding ID of the body, such as 634 for ReadResponse or 397 for ServiceFault.
• request_id Field — ID that pdcomm_opcua_client_begin() returned; equals the ResponseHeader requestHandle.
• reserved Field — Written as zero.
• service_status Field — ResponseHeader serviceResult; Bad only for a ServiceFault.
• struct_size Field — In: size known by the caller.
• version Field — In and out: structure version 1.
• pdcomm_opcua_security_mode Enum — MessageSecurityMode of the secure channel, with the numeric values of the Part 4 MessageSecurityMode enumeration.
• pdcomm_opcua_server_add_variable Function — Adds a Variable node below the Objects folder.
• pdcomm_opcua_server_close Function — Stops the server: closes the listener and aborts every channel.
• pdcomm_opcua_server_create Function — Creates and binds an in-memory OPC UA server.
• pdcomm_opcua_server_local_address Function — Returns the socket address the server listens on.
• pdcomm_opcua_server_options Struct — Server options of the in-memory server facade (structure version 1).
• application_uri Field — ApplicationUri, at most 4096 bytes; empty means urn:pdcomm:opcua:server.
• certificate_der Field — Server application instance certificate (DER, at most 64 KiB); required unless #PDCOMM_OPCUA_ALLOW_NONE is set.
• endpoint 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 Field — 0 or #PDCOMM_OPCUA_ALLOW_NONE.
• max_connections Field — Concurrent secure channels: more than max_sessions and at most 1024 (default 33).
• max_sessions Field — Concurrent sessions, 1 to 1023 (default 32).
• private_key_pem Field — Private key of that certificate (PEM, at most 64 KiB).
• reserved Field — Must be zero.
• struct_size Field — Size of this structure in bytes as known by the caller.
• trusted_client_der Field — The one client certificate this server trusts (DER, at most 64 KiB).
• version Field — Structure version; must be 1.
• pdcomm_opcua_server_options_init Function — Fills server options with the defaults.
• pdcomm_opcua_server_poll Function — Performs one non-blocking server pass: accepts connections and processes received requests and subscriptions.
• pdcomm_opcua_server_read_value Function — Reads the Value attribute of a node as a local, authenticated user.
• pdcomm_opcua_server_set_value Function — Writes the Value attribute of a variable as a local, authenticated user.
• pdcomm_opcua_status Enum — Status code returned by every int32_t OPC UA C ABI function.
• pdcomm_opcua_variable_flags Enum — Flags of pdcomm_opcua_server_add_variable().