Common API reference

• Get started 82 symbols
• SECS/GEM 5266 symbols
• Modbus 64 symbols
• MQTT 0 symbols
• OPC UA 303 symbols
• Tools 56 symbols

• C 23 symbols
• C++ 20 symbols
• .NET 39 symbols

AllCC++.NETAll kindsClassConstructorEnumEnumeratorFunctionMacroMethodNamespacePropertyTypedef82 symbols

• PDCOMM_ALLOCATION_FAILED C Macro — A memory allocation failed.
• PDCOMM_BUFFER_TOO_SMALL C Macro — The output capacity is smaller than the data.
• PDCOMM_INTERNAL_ERROR C Macro — An internal invariant failed or a panic was contained.
• PDCOMM_INVALID_ARGUMENT C Macro — An argument is invalid.
• PDCOMM_INVALID_DATA C Macro — The input bytes are not a valid SECS-II item.
• PDCOMM_IO_ERROR C Macro — An operating-system operation failed.
• PDCOMM_LICENSE_REQUIRED C Macro — A PDComm license that grants the module is required.
• PDCOMM_LIMIT_EXCEEDED C Macro — The request exceeds an application-supplied or protocol limit.
• PDCOMM_OK C Macro — The call succeeded.
• PDCOMM_OUT_OF_RANGE C Macro — An index or identifier does not refer to an existing element.
• PDCOMM_TRUNCATED C Macro — The input ended before a complete SECS-II item was read.
• PdcommBuffer C Typedef — Opaque, immutable, owned byte buffer.
• PdcommStatus C Typedef — Result code returned by fallible PDComm functions.
• pdcomm_abi_version C Function — Returns the ABI version implemented by the loaded library.
• pdcomm_buffer_copy C Function — Copies the bytes of a buffer into caller storage.
• pdcomm_buffer_create C Function — Copies caller bytes into a new owned buffer.
• pdcomm_buffer_destroy C Function — Releases a buffer handle.
• pdcomm_license_host_id C Function — Copies the host id of this machine.
• pdcomm_license_install C Function — Installs PDComm license text for this library.
• pdcomm_license_status C Function — Copies the license status of this library as a JSON object.
• pdcomm_logging_configure C Function — Configures library-local diagnostics logging.
• pdcomm_logging_flush C Function — Waits until queued log records are written to the sink.
• pdcomm_logging_status C Function — Copies the current logging status as a JSON object.
• pdcomm C++ Namespace — Header-only C++ wrappers over the PDComm SECS/GEM C API.
• Buffer C++ Class — Owned, immutable copy of a byte sequence.
• Buffer::Buffer C++ Constructor — Takes ownership of the native handle owned by other.
• Buffer::Buffer C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Buffer::Buffer C++ Constructor — Copies length bytes from data into a new native buffer.
• Buffer::bytes C++ Method — Copies the buffer contents into a new vector.
• Buffer::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• Buffer::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Buffer::~Buffer C++ Method — Releases the native handle with pdcomm_buffer_destroy().
• DiagnosticLogging C++ Class — Controls the optional diagnostic log of the SECS/GEM native library.
• DiagnosticLogging::configure C++ Method — Applies a logging configuration given as a JSON object.
• DiagnosticLogging::flush C++ Method — Waits until queued log records are written.
• DiagnosticLogging::status C++ Method — Returns the current logging status as a JSON object.
• Error C++ Class — Exception thrown when a native PDComm call returns a status other than PDCOMM_OK.
• Error::Error C++ Constructor — Creates an exception for a failed native call.
• Error::status C++ Method — Returns the native status that caused this exception.
• License C++ Class — Installs and inspects the PDComm license of the SECS/GEM 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 of the SECS/GEM library as a JSON object.
• PdcommStatus.AllocationFailed .NET Enumerator — The native library could not allocate memory; the operation can be retried.
• PdcommStatus.Backpressure .NET Enumerator — A bounded queue is full; drain events or wait for pending work to finish, then retry.
• PdcommStatus.BufferTooSmall .NET Enumerator — The output buffer is smaller than the required size; nothing was copied.
• PdcommStatus.InternalError .NET Enumerator — An internal error occurred in the native library.
• PdcommStatus.InvalidArgument .NET Enumerator — An argument, option structure or handle was invalid for the operation.
• PdcommStatus.InvalidData .NET Enumerator — The input bytes are not valid for their declared format, for example a malformed SECS-II item.
• PdcommStatus.InvalidState .NET Enumerator — The operation is not allowed in the endpoint's current state.
• PdcommStatus.IoError .NET Enumerator — A socket, file or other I/O operation failed.
• PdcommStatus.LicenseRequired .NET Enumerator — No PDComm license grants the module, so no new communication was started. Running endpoints are not affected.
• PdcommStatus.LimitExceeded .NET Enumerator — A size, count, nesting or other configured limit would be exceeded.
• PdcommStatus.Ok .NET Enumerator — The operation succeeded.
• PdcommStatus.OutOfRange .NET Enumerator — An index, identifier or requested entry does not exist.
• PdcommStatus.Poisoned .NET Enumerator — An earlier internal failure poisoned the native object; only disposal is meaningful afterwards.
• PdcommStatus.ProgramUnconfirmed .NET Enumerator — A process program change was installed, but its durable persistence could not be confirmed.
• PdcommStatus.SpoolUnconfirmed .NET Enumerator — A spooling change was installed, but its durable persistence could not be confirmed.
• PdcommStatus.StaleToken .NET Enumerator — A token or result belongs to another endpoint, to an earlier connection generation, or was already consumed.
• PdcommStatus.Truncated .NET Enumerator — The input ended before a complete SECS-II item could be decoded.
• 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.
• License.HostId .NET Method — Gets this machine's host id, PDH1-XXXX-XXXX-XXXX-XXXX, which SECS/GEM runtime licenses list.
• License.Install .NET Method — Installs license text, replacing text installed earlier through this method.
• License.Status .NET Method — Gets the license status of the SECS/GEM library.
• PdcommBuffer.Create .NET Method — Copies bytes into a new native buffer.
• PdcommBuffer.Dispose .NET Method — Releases the native buffer.
• PdcommBuffer.ToArray .NET Method — Copies the buffer's contents into a new array.
• PdcommBuffer.TryCopy .NET Method — Copies the buffer's contents into a caller-supplied span when it is large enough.
• PdcommException.PdcommException .NET Constructor — Initializes a new exception for a native status.
• PdcommRuntime.Initialize .NET Method — Loads and validates the PDComm native library.
• PDComm .NET Namespace
• PdcommException.ErrorOffset .NET Property — Gets the byte offset of the start of the field that failed to decode, or null when the failure has no input position.
• PdcommException.Status .NET Property — Gets the native status that caused the failure.
• PdcommRuntime.AbiVersion .NET Property — Gets the ABI version of the loaded native library, as major.minor.
• DiagnosticLogging .NET Class — Controls the optional diagnostic log of the PDComm SECS/GEM native library.
• License .NET Class — Installs and inspects the PDComm license of the SECS/GEM native library.
• PdcommBuffer .NET Class — An immutable byte buffer owned by the PDComm native library.
• PdcommException .NET Class — The exception thrown when a PDComm native operation returns a status other than PdcommStatus.Ok.
• PdcommRuntime .NET Class — Loads the PDComm native library and checks that its ABI is compatible with this binding.
• PdcommStatus .NET Enum — Status codes returned by the PDComm native library.