Modbus API reference

• C 22 symbols
• C++ 24 symbols
• .NET 18 symbols

AllCC++.NETAll kindsClassConstructorEnumEnumeratorFunctionMethodNamespacePropertyTypedef64 symbols

• PDCOMM_MODBUS_ASCII C Enumerator — Modbus ASCII over a serial line (Modbus over Serial Line specification).
• PDCOMM_MODBUS_BUFFER_TOO_SMALL C Enumerator — The output capacity is smaller than the data. The required size is reported and the output is unchanged.
• PDCOMM_MODBUS_INTERNAL_ERROR C Enumerator — An internal failure, such as a contained panic or a poisoned endpoint lock. Release the endpoint and create a new one.
• PDCOMM_MODBUS_INVALID_HANDLE C Enumerator — The handle is zero, released, unknown or of the wrong kind.
• PDCOMM_MODBUS_INVALID_INPUT C Enumerator — A pointer, size or JSON document is invalid; nothing was changed.
• PDCOMM_MODBUS_OK C Enumerator — The call succeeded.
• PDCOMM_MODBUS_RTU C Enumerator — Modbus RTU over a serial line (Modbus over Serial Line specification).
• PDCOMM_MODBUS_SECURITY C Enumerator — Modbus/TCP Security: TLS with X.509 certificates and role-based authorization.
• PDCOMM_MODBUS_SERVICE_ERROR C Enumerator — The command ran and failed, for example with a timeout, a refused connection or an invalid configuration. An owned error buffer is returned.
• PDCOMM_MODBUS_TCP C Enumerator — Modbus TCP (MBAP header over TCP), client, server and gateway listener.
• pdcomm_modbus_abi_version C Function — Returns the ABI version of the loaded library.
• pdcomm_modbus_buffer_copy C Function — Copies a JSON reply buffer as UTF-8 without a terminator.
• pdcomm_modbus_call C Function — Runs one JSON command on an endpoint and returns the JSON reply.
• pdcomm_modbus_capabilities C Function — Returns the features compiled into the loaded library.
• pdcomm_modbus_capability C Enum — Feature bits reported by pdcomm_modbus_capabilities().
• pdcomm_modbus_endpoint_create C Function — Creates a disconnected endpoint with the default configuration.
• pdcomm_modbus_handle C Typedef — Opaque, library-local handle of an endpoint or a JSON buffer.
• pdcomm_modbus_logging_configure C Function — Configures the optional diagnostic log of this library.
• pdcomm_modbus_logging_flush C Function — Waits until queued log records are written to the sink.
• pdcomm_modbus_logging_status C Function — Copies the diagnostic log status as UTF-8 JSON without a terminator.
• pdcomm_modbus_release C Function — Releases an endpoint or a JSON buffer.
• pdcomm_modbus_status C Enum — Status code returned by every int32_t Modbus C ABI function.
• modbus C++ Namespace — Modbus C++ API: RAII handles, JSON command endpoints and diagnostic logging, plus the Qt and MFC adapters in bindings/.
• DiagnosticLogging C++ Class — Static functions that configure, inspect and flush the optional JSON Lines diagnostic log of the Modbus library.
• DiagnosticLogging::configure C++ Method — Applies a logging configuration.
• DiagnosticLogging::flush C++ Method — Waits up to two seconds until queued records are written.
• DiagnosticLogging::status C++ Method — Returns the logging status as JSON.
• Endpoint C++ Class — One Modbus endpoint that runs JSON commands.
• Endpoint::Endpoint C++ Constructor — Creates a disconnected endpoint with the default configuration.
• Endpoint::call C++ Method — Runs one JSON command and returns the complete reply.
• Handle C++ Class — Move-only owner of one ::pdcomm_modbus_handle.
• Handle::Handle C++ Constructor — Moves ownership; other becomes empty.
• Handle::Handle C++ Constructor — Copying is disabled: a handle has exactly one owner.
• Handle::Handle C++ Constructor — Takes ownership of a handle.
• Handle::get C++ Method — Returns the owned handle without giving up ownership.
• Handle::operator= C++ Method — Releases the current handle, then takes ownership from other.
• Handle::operator= C++ Method — Copy assignment is disabled: a handle has exactly one owner.
• Handle::~Handle C++ Method — Releases the owned handle, if any.
• License C++ Class — Static functions that install license text and read the license status and this host id of the Modbus library.
• License::hostId 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 as JSON.
• MfcEndpoint C++ Class — Modbus endpoint that runs CString JSON commands.
• MfcEndpoint::Call C++ Method — Runs one JSON command and returns the complete reply.
• QtEndpoint C++ Class — Modbus endpoint that takes a QJsonObject command and returns the result object of the reply.
• QtEndpoint::call C++ Method — Runs one JSON command and returns its result object.
• DiagnosticLogging.Configure .NET Method — Replaces the diagnostic log configuration.
• DiagnosticLogging.Flush .NET Method — Waits until the queued log records have been written.
• DiagnosticLogging.Status .NET Method — Gets the current logging state and counters.
• Endpoint.Endpoint .NET Constructor — Creates a native Modbus endpoint.
• Endpoint.Call .NET Method — Runs one JSON command on the endpoint and returns its result.
• Endpoint.Dispose .NET Method — Releases the native endpoint.
• Endpoint.pdcomm_modbus_capabilities .NET Method — Gets the features compiled into the loaded native library.
• 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.
• License.Status .NET Method — Gets the license status of the Modbus library.
• Modbus .NET Namespace
• ModbusCommandException.Code .NET Property — Gets the machine-readable error code, or null for errors without one. Codes: license_required (a connect refused without a valid license for modbus, or for modbus-security when security is configured), license_invalid (a license_install without a verifiable license) and host_id_unavailable.
• ModbusCommandException.Details .NET Property — Gets the license object of a license_required reply, with the refused module, its license state (for example missing or expired) and the deciding license_id; otherwise null.
• ModbusCommandException.LicenseRequired .NET Property — Gets whether the command was refused for lack of a PDComm license (ModbusCommandException.Code is license_required). Connections that are already open are not affected.
• DiagnosticLogging .NET Class — Controls the optional diagnostic log of the PDComm Modbus native library.
• Endpoint .NET Class — A PDComm Modbus endpoint driven by JSON commands: a Modbus TCP, RTU or ASCII client or server (simulator).
• License .NET Class — Installs and inspects the PDComm license of the Modbus native library.
• ModbusCommandException .NET Class — The exception thrown when a Modbus endpoint rejects a command (native status SERVICE_ERROR).