KafkaAdapters

Defines extensions methods for instances.

Fetches a single result for the specified and .

Router used to fetch result. Topic to fetch result from. Partition ID to fetch result from. Offset of to begin fetching result. Defines maximum size of request that can be adjusted for large serializations. A instance, if available; otherwise, null.

Gets the latest offset for a Topic partition.

Router used to derive latest offset. Topic to determine latest offset for. Topic partition to determine latest offset for. The latest offset for a partition in a topic.

Represents a record of Kafka time-series metadata.

Creates a new .

Date-time format used by .

Measurement ID, i.e., locally unique metadata index.

Cross-system unique measurement identification.

Assigned point tag of measurement, if any.

Acronym of primary measurement source, e.g., a historian.

Acronym of device that creates measurements.

Longitude of device that creates the measurements.

Latitude of device that creates the measurements.

Acronym of device protocol used for transporting measured values.

Acronym of type of measured value, e.g., FREQ for frequency.

Engineering units associated with signal type, if any.

When measurement is part of a phasor, value will be V for voltage or I for current; otherwise null.

When measurement is part of a phasor, represents the phase of the measured value; otherwise null.

Description of the measurement.

Last update date and time of the metadata record in UTC. Format = yyyy-MM-dd HH:mm:ss.fff

Parses string as a .

as a .

Calculates a CRC-32 based check-sum on this instance.

CRC-32 based check-sum on this instance.

Defines the data quality flags applied to a Kafka serialized measurement.

If no flags are set, measurement quality is normal.

If bit 0 is set, measurement value quality is bad - as reported by source.

If bit 1 is set, measurement time quality is bad - as reported by source.

Decode version mask - remaining bits used for decoding version, allows 64 possible versions (0 to 63).

Defines extension methods for handling Kafka message serialization to and from time-series measurements.

The goal of this serialization implementation is to make it very simple to deserialize Kafka time-series messages from other language implementations, such as C++ or Java.

Defines the size of serialized Kafka measurement key.

Key format:
- long Time: 64-bit time of measurement in ticks, i.e., 100-nanosecond intervals since 0/0/0000
- uint ID: 32-bit measurement identifier (temporal index into metadata)

Defines the size of serialized Kafka measurement value.

Value format:
- byte Version: 8-bit metadata serialization version
- byte Quality: 8-bit measurement quality - bit 0 = bad value, bit 1 = bad time*
- double Value: 64-bit floating-point measurement value * Remaining bits used to define decoding version.

Defines the current message decoding version.

Serializes a time-series instance into key-value buffers for a Kafka message.

instance to serialize. Kafka message to hold serialized key-value buffers. Current metadata serialization version.

Deserializes a Kafka message into a time-series .

Time-series serialized Kafka message. Numeric ID of measurement deserialized from Kafka message. Message metadata serialization version. value deserialized from a time-series serialized Kafka message.

Derive Kafka time-seres data quality flags from measurement state flags

Derive measurement state flags from Kafka time-seres data quality flags

Defines an proxy for Kafka log messages.

Represents a Kafka adapter that will receive time-series data to send into the Time-Series Library.

Defines the default value for the property.

Creates a new instance.

Gets or sets Kafka servers to connect to, comma separated.

Gets or sets the Kafka topic name.

Gets the Kafka metadata topic name.

Gets or sets the total number of partitions used for data distribution.

Gets or sets flag that determines if consumer offset should be tracked between adapter instantiations.

Gets or sets file name to use for consumer offset base file name.

Gets or set minimum cache interval for consumer offset tracking.

Gets or sets read delay, in milliseconds, for messages with timestamp changes. Set to -1 for no delay, i.e., read as fast as possible.

Gets or sets flag that determines if metadata should cached locally.

Gets the flag indicating if this adapter supports temporal processing.

Gets flag that determines if the data output stream connects asynchronously.

Derived classes should return true when data output stream connects asynchronously, otherwise return false.

Returns the detailed status of the data input source. Derived classes should extend status with implementation specific information.

Initializes .

Attempts to connect to data output stream.

Derived classes should attempt connection to data output stream here. Any exceptions thrown by this implementation will result in restart of the connection cycle.

Attempts to disconnect from data output stream.

Derived classes should attempt disconnect from data output stream here. Any exceptions thrown by this implementation will be reported to host via event.

Gets a short one-line status of this .

Maximum number of available characters for display. A short one-line summary of the current status of this .

Represents a set of Kafka time-series metadata.

Defines the version of this time-series metadata instance.

Defines the records of this time-series metadata instance.

Gets the count of records in the time-series metadata.

Calculates a CRC-32 based check-sum on this instance.

CRC-32 based check-sum on this instance.

Serializes instance to a stream of XML.

Source time-series metadata object to serialize. Destination stream to hold serialized data. Determines of metadata version should be incremented.

Deserializes a stream of XML metadata as a instance.

Source stream of serialized data. Deserialized instance.

Writes time-series metadata to specified Kafka .

Source time-series metadata object to write to Kafka. Kafka router connection. Kafka topic.

Reads latest time-series metadata from specified Kafka .

Kafka router connection. Kafka topic. Serialization time. Status message function. Latest instance read from Kafka.

Caches meta-data locally.

Source time-series metadata object to cache. Kafka topic. Status message function.

Represents a Kafka adapter that will produce time-series data based on output from the Time-Series Library.

Defines the default value for the property.

Gets or sets Kafka servers to connect to, comma separated.

Gets or sets the Kafka topic name.

Gets the Kafka metadata topic name.

Gets or sets the total number of partitions used for data distribution.

Gets or sets the encoding used to serialize measurements into the Kafka stream. Default value of null defines binary encoding.

Gets or sets the text format for measurement timestamps.

Gets or sets the text format for measurement values.

Gets or sets flag that determines if metadata should be serialized into Kafka.