|
Time
|
Represents a Kafka adapter that will produce time-series data based on output from the Time-Series Library.
Inheritance Hierarchy
SystemObject
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersOutputAdapterBase
KafkaAdaptersTimeSeriesProducer
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersOutputAdapterBase
KafkaAdaptersTimeSeriesProducer
Namespace: KafkaAdapters
Assembly: KafkaAdapters (in KafkaAdapters.dll) Version: 2.4.218-beta
SyntaxThe TimeSeriesProducer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TimeSeriesProducer | Initializes a new instance of the TimeSeriesProducer class |
Properties| Name | Description | |
|---|---|---|
 | AutoStart |
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase) |
| CacheMetadataLocally | Gets or sets flag that determines if metadata should cached locally. |
 | ConnectionAttemptInterval |
Gets or sets the connection attempt interval, in milliseconds, for the data output adapter.
(Inherited from OutputAdapterBase) |
| ConnectionInfo |
Gets connection info for adapter, if any.
(Inherited from AdapterBase) |
| ConnectionString |
Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase) |
| DataSource |
Gets or sets DataSet based data source available to this OutputAdapterBase.
(Inherited from OutputAdapterBase) |
| Enabled |
Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase) |
| Encoding | Gets or sets the encoding used to serialize measurements into the Kafka stream. Default value of null defines binary encoding. |
| ID |
Gets or sets numeric ID associated with this AdapterBase.
(Inherited from AdapterBase) |
| InitializationTimeout |
Gets or sets maximum time system will wait during Start for initialization.
(Inherited from AdapterBase) |
| Initialized |
Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from AdapterBase) |
| InputMeasurementKeys |
Gets or sets primary keys of input measurements the AdapterBase expects, if any.
(Inherited from AdapterBase) |
| InputSourceIDs |
Gets or sets Source values used to filter input measurements.
(Inherited from OutputAdapterBase) |
| InternalProcessQueue |
Allows derived class access to internal processing queue.
(Inherited from OutputAdapterBase) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase) |
| Log |
Log messages generated by an adapter.
(Inherited from AdapterBase) |
| MeasurementReportingInterval |
Gets or sets the measurement reporting interval.
(Inherited from AdapterBase) |
| MetadataRefreshOperation |
Gets the operation that calls ExecuteMetadataRefresh.
(Inherited from OutputAdapterBase) |
| MetadataTopic | Gets the Kafka metadata topic name. |
| Name |
Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase) |
| OutputIsForArchive |
Gets the flag that determines if measurements sent to this OutputAdapterBase are destined for archival.
(Overrides OutputAdapterBaseOutputIsForArchive) |
| OutputMeasurements |
Gets or sets output measurements that the AdapterBase will produce, if any.
(Inherited from OutputAdapterBase) |
| Partitions | Gets or sets the total number of partitions used for data distribution. |
| ProcessedMeasurements |
Gets the total number of measurements handled thus far by the AdapterBase.
(Inherited from AdapterBase) |
| ProcessingInterval |
Gets or sets the desired processing interval, in milliseconds, for the output adapter.
(Inherited from OutputAdapterBase) |
| RequestedInputMeasurementKeys |
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from OutputAdapterBase) |
| RequeueOnException |
Gets or sets whether or not to automatically place measurements back into the processing
queue if an exception occurs while processing. Defaults to false.
(Inherited from OutputAdapterBase) |
| RunTime |
Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase) |
| SerializeMetadata | Gets or sets flag that determines if metadata should be serialized into Kafka. |
| Servers | Gets or sets Kafka servers to connect to, comma separated. |
| Settings |
Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase) |
| StartTime |
Gets the UTC time this AdapterBase was started.
(Inherited from AdapterBase) |
| StartTimeConstraint |
Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase) |
| Status |
Returns the detailed status of the data input source. Derived classes should extend status with implementation specific information.
(Overrides OutputAdapterBaseStatus) |
| StopTime |
Gets the UTC time this AdapterBase was stopped.
(Inherited from AdapterBase) |
| StopTimeConstraint |
Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase) |
| SupportsTemporalProcessing |
Gets the flag indicating if this OutputAdapterBase implementation supports temporal processing.
(Inherited from OutputAdapterBase) |
| TimestampFormat | Gets or sets the text format for measurement timestamps. |
| Topic | Gets or sets the Kafka topic name. |
| UseAsyncConnect |
Gets flag that determines if the data output stream connects asynchronously.
(Overrides OutputAdapterBaseUseAsyncConnect) |
| ValueFormat | Gets or sets the text format for measurement values. |
Methods| Name | Description | |
|---|---|---|
 | AttemptConnection |
Attempts to connect to data output stream.
(Overrides OutputAdapterBaseAttemptConnection) |
| AttemptDisconnection |
Attempts to disconnect from data output stream.
(Overrides OutputAdapterBaseAttemptDisconnection) |
| Dispose |
Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the OutputAdapterBase object and optionally releases the managed resources.
(Inherited from OutputAdapterBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteMetadataRefresh |
Executes the metadata refresh in a synchronous fashion.
(Overrides OutputAdapterBaseExecuteMetadataRefresh) |
| Finalize |
Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase) |
| Flush |
Blocks the current thread, if the OutputAdapterBase is connected, until all items
in OutputAdapterBase queue are processed, and then stops processing.
(Inherited from OutputAdapterBase) |
| GetHashCode |
Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase) |
| GetShortStatus |
Gets a short one-line status of this AdapterBase.
(Overrides AdapterBaseGetShortStatus(Int32)) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IncrementProcessedMeasurements |
Safely increments the total processed measurements.
(Inherited from AdapterBase) |
| Initialize |
Initializes TimeSeriesProducer.
(Overrides OutputAdapterBaseInitialize) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterBase) |
| OnConnected |
Called when data output source connection is established.
(Inherited from OutputAdapterBase) |
| OnDisconnected |
Called when data input source is disconnected.
(Inherited from OutputAdapterBase) |
| OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase) |
| OnOutputMeasurementsUpdated |
Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase) |
| OnProcessException(Exception) | Obsolete. Raises the ProcessException event. (Inherited from AdapterBase) |
| OnProcessException(MessageLevel, Exception, String, MessageFlags) |
Raises the ProcessException event.
(Inherited from AdapterBase) |
| OnStatusMessage(String) | Obsolete. Raises the StatusMessage event. (Inherited from AdapterBase) |
| OnStatusMessage(String, Object) | Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterBase) |
| OnStatusMessage(MessageLevel, String, String, MessageFlags) |
Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterBase) |
| OnUnprocessedMeasurements |
Raises the UnprocessedMeasurements event.
(Inherited from OutputAdapterBase) |
| ProcessMeasurements |
Serializes measurements to data output stream.
(Overrides OutputAdapterBaseProcessMeasurements(IMeasurement)) |
| QueueMeasurementForProcessing |
Queues a single measurement for processing. Measurement is automatically filtered to the defined InputMeasurementKeys.
(Inherited from OutputAdapterBase) |
| QueueMeasurementsForProcessing |
Queues a collection of measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys.
(Inherited from OutputAdapterBase) |
| RefreshMetadata |
Initiates request for metadata refresh for OutputAdapterBase, if implemented.
(Inherited from OutputAdapterBase) |
| RemoveMeasurements |
This removes a range of measurements from the internal measurement queue.
(Inherited from OutputAdapterBase) |
| SetInitializedState |
Manually sets the initialized state of the AdapterBase.
(Inherited from AdapterBase) |
| SetTemporalConstraint |
Defines a temporal processing constraint for the adapter.
(Inherited from AdapterBase) |
| Start |
Starts this OutputAdapterBase and initiates connection cycle to data output stream.
(Inherited from OutputAdapterBase) |
| Stop |
Stops this OutputAdapterBase and disconnects from data output stream.
(Inherited from OutputAdapterBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase) |
| Disposed |
Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase) |
| OutputMeasurementsUpdated |
Event is raised when OutputMeasurements are updated.
(Inherited from AdapterBase) |
| ProcessException |
Event is raised when there is an exception encountered while processing.
(Inherited from AdapterBase) |
| StatusMessage |
Provides status messages to consumer.
(Inherited from AdapterBase) |
| UnprocessedMeasurements |
Event is raised every five seconds allowing host to track total number of unprocessed measurements.
(Inherited from OutputAdapterBase) |
Fields| Name | Description | |
|---|---|---|
  | DefaultCacheMetadataLocally | Defines the default value for the CacheMetadataLocally property. |
| DefaultEncoding | Defines the default value for the Encoding property. |
| DefaultPartitions | Defines the default value for the Partitions property. |
| DefaultSerializeMetadata | Defines the default value for the SerializeMetadata property. |
| DefaultTimestampFormat | Defines the default value for the TimestampFormat property. |
| DefaultTopic | Defines the default value for the Topic property. |
| DefaultValueFormat | Defines the default value for the ValueFormat property. |
See Also