client-api.md

eyebrow	Docs · Reference
lede	Every method on OpcUaClientInterface, grouped by concern. Use the topical operations pages to learn each call; this page is the alphabetical surface.
see_also	href meta ./builder-api.md 6 min href meta ./exceptions.md 7 min href meta ../operations/reading-attributes.md 7 min
prev	label href Integration tests ../testing/integration.md
next	label href Builder API ./builder-api.md

Client API

PhpOpcua\Client\OpcUaClientInterface — the public contract every Client (real or mock) implements. Methods are grouped here by concern; each links to the page that explains it in depth.

Methods that observe or transition the connection state.

See Connection · Opening and closing.

Discover the methods and modules the client exposes at runtime.

Used by ManagedClient (in opcua-session-manager) and by callers that branch on optional service-set availability. See Recipes · Detecting server capabilities.

Single and multi-node attribute reads.

See Operations · Reading attributes.

Single and multi-node value writes.

See Operations · Writing values.

Address-space navigation.

See Operations · Browsing.

Translate browse paths to NodeIds.

See Operations · Resolving paths.

Invoke server-side procedures.

See Operations · Calling methods.

Server-pushed notifications via the publish loop.

See Operations · Subscriptions.

Per-attribute and per-event observation.

See Operations · Monitored items.

Read stored historical data. Optional service set.

See Operations · History reads.

Insert, replace, update, and delete on raw values and on historical events. Optional service set; many servers do not implement it.

See Operations · History writes.

Open / read / write / close on FileType instances (Part 5 §C). Method NodeIds are resolved and cached per-file.

See Operations · File Transfer.

Mutate the address space. Optional service set.

See Operations · Managing nodes.

Endpoint discovery and well-known server-info shortcuts.

Manual control over the PSR-16 cache.

See Observability · Caching.

Per-client view of the configured trust store.

See Security · Trust store.

Read-only views of the builder values frozen into this client.

These accessors are useful in middleware-style code that branches on the active configuration — testing infrastructure that injects a client and wants to verify the builder set the right defaults, mostly.

For the write side of these (the setters), see Builder API.