Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

Channels

Read and modify channel definitions, values, fields, and history through the Engine SDK.

DeclarationDescription
ChannelFieldAddressable fields stored for each RAPID channel.
ChannelValueValue types accepted by channel read, write, and authority APIs.
SDK_API::createFixedChannelCreates a channel in fixed RAPID storage, or promotes an existing dynamic channel.
FixedChannelBatchOrdered channel names and handles used by the fixed-channel batch APIs.
FixedChannelHandleStable, pre-resolved address of a fixed RAPID channel.
SDK_API::insertChannelFieldCreates a missing channel with an initial field value; an existing channel is left unchanged.
SDK_API::queryChannelFieldReads a typed field and returns the supplied default when the field is unavailable.
SDK_API::queryFixedChannelValuesReads a coherent task-input snapshot into caller-owned storage.
RecordModeControls when channel values are recorded to persistence.
SDK_API::removeChannelRemoves a channel and its associated field data.
SDK_API::resolveFixedChannelsResolves fixed channels during configuration to avoid repeated name lookup in callbacks.
SDK_API::upsertChannelFieldCreates or replaces a field on a RAPID channel.
SDK_API::upsertChannelValueBulkWrites timestamped numeric samples to one channel in a single call.
SDK_API::upsertFixedChannelValuesStages one value per fixed channel in the current task transaction.