|
IClient
|
Represents a common set of interfaces for a client adapter subscription to the DataPublisher.
Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.230-beta
Syntaxpublic interface IClientSubscription : IActionAdapter, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus
The IClientSubscription type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AutoStart |
Gets or sets flag indicating if adapter should automatically start or connect on demand.
(Inherited from IAdapter) |
| ClientID | Gets the Guid client TCP connection identifier of this IClientSubscription. |
| CompressionStrength | Gets or sets the compression strength value to use when UsePayloadCompression is true for this IClientSubscription. |
| ConnectionInfo |
Gets connection info for adapter, if any.
(Inherited from IAdapter) |
| ConnectionString |
Gets or sets key/value pair connection information specific to IAdapter.
(Inherited from IAdapter) |
| DataSource |
Gets or sets DataSet based data source available to IAdapter.
(Inherited from IAdapter) |
| Enabled |
Gets or sets a boolean value that indicates whether the object is enabled.
(Inherited from ISupportLifecycle) |
| ID |
Gets or sets the numeric ID associated with this IAdapter.
(Inherited from IAdapter) |
| InitializationTimeout |
Gets or sets maximum time system will wait during Start for initialization.
(Inherited from IAdapter) |
| Initialized |
Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from IAdapter) |
| InputMeasurementKeys |
Gets or sets primary keys of input measurements the adapter expects.
(Inherited from IAdapter) |
| InputSourceIDs |
Gets or sets Source values used to filter input measurement keys.
(Inherited from IActionAdapter) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from ISupportLifecycle) |
| MeasurementReportingInterval | Gets or sets the measurement reporting interval. |
| Name |
Gets or sets name of this IAdapter.
(Inherited from IAdapter) |
| OutputMeasurements |
Gets or sets output measurements that the adapter will produce, if any.
(Inherited from IAdapter) |
| OutputSourceIDs |
Gets or sets Source values used to filter output measurements.
(Inherited from IActionAdapter) |
| ProcessedMeasurements |
Gets the total number of measurements processed thus far by the IAdapter.
(Inherited from IAdapter) |
| ProcessingInterval |
Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from IAdapter) |
| RequestedInputFilter | Gets the input filter requested by the subscriber when establishing this IClientSubscription. |
| RequestedInputMeasurementKeys |
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from IActionAdapter) |
| RequestedOutputMeasurementKeys |
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from IActionAdapter) |
| RespectInputDemands |
Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
(Inherited from IActionAdapter) |
| RespectOutputDemands |
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
(Inherited from IActionAdapter) |
| Settings |
Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from IAdapter) |
| SignalIndexCache | Gets the current signal index cache of this IClientSubscription. |
| StartTimeConstraint |
Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from IAdapter) |
| Status |
Gets the current status details about object providing status information.
(Inherited from IProvideStatus) |
| StopTimeConstraint |
Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from IAdapter) |
| SubscriberID | Gets the Guid based subscriber ID of this IClientSubscription. |
| SupportsTemporalProcessing |
Gets the flag indicating if this adapter supports temporal processing.
(Inherited from IAdapter) |
| TemporalSessionStatus | Gets the status of the active temporal session, if any. |
| TimestampSize | Gets size of timestamp in bytes. |
| UseCompactMeasurementFormat | Gets or sets flag that determines if the compact measurement format should be used in data packets of this IClientSubscription. |
| UsePayloadCompression | Gets or sets flag that determines if payload compression should be enabled in data packets of this IClientSubscription. |
Methods| Name | Description | |
|---|---|---|
 | ConfirmBufferBlock | Handles the confirmation message received from the subscriber to indicate that a buffer block was received. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| GetShortStatus |
Gets a short one-line adapter status.
(Inherited from IAdapter) |
| Initialize |
Initializes the state of the object.
(Inherited from ISupportLifecycle) |
| OnProcessException | Explicitly raises the ProcessException event. |
| OnProcessingCompleted | Explicitly raises the ProcessingComplete event. |
| OnStatusMessage | Explicitly raises the StatusMessage event. |
| QueueMeasurementsForProcessing |
Queues measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys.
(Inherited from IActionAdapter) |
| SetTemporalConstraint |
Defines a temporal processing constraint for the adapter.
(Inherited from IAdapter) |
| Start |
Starts the adapter, if it is not already running.
(Inherited from IAdapter) |
| Stop |
Stops the adapter.
(Inherited from IAdapter) |
Events| Name | Description | |
|---|---|---|
 | BufferBlockRetransmission | Indicates that a buffer block needed to be retransmitted because it was previously sent, but no confirmation was received. |
| ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from IAdapter) |
| DiscardingMeasurements |
This event is raised if there are any measurements being discarded during the sorting process.
(Inherited from IActionAdapter) |
| Disposed |
Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from IAdapter) |
| NewMeasurements |
Provides new measurements from action adapter.
(Inherited from IActionAdapter) |
| OutputMeasurementsUpdated |
Event is raised when OutputMeasurements are updated.
(Inherited from IAdapter) |
| ProcessException |
Event is raised when there is an exception encountered while processing.
(Inherited from IAdapter) |
| ProcessingComplete | Indicates to the host that processing for an input adapter (via temporal session) has completed. |
| StatusMessage |
Provides status messages to consumer.
(Inherited from IAdapter) |
| UnpublishedSamples |
This event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.
(Inherited from IActionAdapter) |
Extension Methods| Name | Description | |
|---|---|---|
 | CreateTemporalSession |
Returns a new temporal IaonSession for a IClientSubscription.
(Defined by IClientSubscriptionExtensions) |
| DisposeTemporalSession |
Disposes a temporal IaonSession created using CreateTemporalSession(IClientSubscription).
(Defined by IClientSubscriptionExtensions) |
| GetMeasurementRecord |
Gets measurement record, creating it if needed.
(Defined by MetadataHelpers) |
| GetParentDevice |
Gets ID of parent device, creating or updating record if needed, for the current IAdapter instance.
(Defined by MetadataHelpers) |
| InputMeasurementKeys |
Returns the MeasurementKey values of the IAdapter input measurements.
(Defined by IAdapterExtensions) |
| LookupDevice |
Looks up associated device acronym and ID from provided signalID.
(Defined by MetadataHelpers) |
| LookupMeasurementKey |
Looks up or creates measurement key based on provided signalID.
(Defined by MetadataHelpers) |
| LookupPointTag |
Looks up point tag name from provided signalID.
(Defined by MetadataHelpers) |
| LookupSignalReference |
Looks up signal reference from provided signalID.
(Defined by MetadataHelpers) |
| OnConfigurationChanged |
Notifies host system of configuration changes.
(Defined by MetadataHelpers) |
| OutputMeasurementKeys |
Returns the MeasurementKey values of the IAdapter output measurements.
(Defined by IAdapterExtensions) |
| PointTagExists |
Determines if pointTag exists in local configuration.
(Defined by MetadataHelpers) |
| SignalIDExists |
Determines if signalID exists in local configuration.
(Defined by MetadataHelpers) |
| SignalReferenceExists |
Determines if signalReference exists in local configuration.
(Defined by MetadataHelpers) |
| TemporalConstraintIsDefined |
Returns true if IAdapter has a temporal constraint defined, i.e., either
StartTimeConstraint or StopTimeConstraint is not
set to its default value.
(Defined by IAdapterExtensions) |
| WaitForSignalsToLoad |
Waits for signalIDs to be loaded in system configuration.
(Defined by MetadataHelpers) |
See Also