Data
|
[EditorBrowsableAttribute(EditorBrowsableState.Advanced)] public class DataSubscriber : InputAdapterBase
The DataSubscriber type exposes the following members.
Name | Description | |
---|---|---|
DataSubscriber | Creates a new DataSubscriber. |
Name | Description | |
---|---|---|
AllowedParsingExceptions | Gets or sets number of parsing exceptions allowed during ParsingExceptionWindow before connection is reset. | |
Authenticated | Gets flag that determines if this DataSubscriber has successfully authenticated with the DataPublisher. | |
AutoConnect | Gets or sets flag that determines if DataSubscriber should attempt to auto-connection to DataPublisher using defined connection settings. | |
AutoStart |
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase) | |
AutoSynchronizeMetadata | Gets or sets flag that determines if DataSubscriber should automatically request meta-data synchronization and synchronize publisher meta-data with its own database configuration. | |
AverageMeasurementsPerSecond | Gets the average value of the measurements per second calculation. | |
CommandChannel | Gets or sets reference to TcpClient command channel, attaching and/or detaching to events as needed. | |
CommandChannelConnected | Gets flag that determines whether the command channel is connected. | |
CompressionModes | Gets or sets the CompressionModes used by the subscriber and publisher. | |
CompressMetadata | Gets or sets the operational mode flag to compress meta-data. | |
CompressPayload | Gets or sets the operational mode flag to compress data payloads. | |
CompressSignalIndexCache | Gets or sets the operational mode flag to compress the signal index cache. | |
ConnectionAttemptInterval |
Gets or sets the connection attempt interval, in milliseconds, for the data input source.
(Inherited from InputAdapterBase) | |
ConnectionInfo |
Gets connection info for adapter, if any.
(Overrides AdapterBaseConnectionInfo) | |
ConnectionString |
Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase) | |
DataChannel | Gets or sets reference to UdpClient data channel, attaching and/or detaching to events as needed. | |
DataLossInterval | Gets or sets data loss monitoring interval, in seconds. Set to zero to disable monitoring. | |
DataSource |
Gets or sets DataSet based data source available to this DataSubscriber.
(Overrides AdapterBaseDataSource) | |
EnableConnectionErrors |
When false, connection errors do not get logged through OnProcessException. When true, connection errors will be logged normally.
(Inherited from InputAdapterBase) | |
Enabled |
Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase) | |
Encoding | Gets the character encoding defined by the OperationalEncoding of the communications stream. | |
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 InputAdapterBase) | |
IsConnected |
Gets flag that determines if InputAdapterBase is connected.
(Inherited from InputAdapterBase) | |
IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase) | |
LifetimeAverageLatency | Gets the average latency calculated over the full lifetime of the subscriber. | |
LifetimeMaximumLatency | Gets the maximum latency calculated over the full lifetime of the subscriber. | |
LifetimeMeasurements | Gets the total number of measurements processed through this data publisher over the lifetime of the subscriber. | |
LifetimeMinimumLatency | Gets the minimum latency calculated over the full lifetime of the subscriber. | |
Log |
Log messages generated by an adapter.
(Inherited from AdapterBase) | |
LoggingPath | Gets or sets logging path to be used to be runtime and outage logs of the subscriber which are required for automated data recovery. | |
MaximumMeasurementsPerSecond | Gets the maximum value of the measurements per second calculation. | |
MeasurementReportingInterval |
Gets or sets the measurement reporting interval.
(Inherited from AdapterBase) | |
MetadataFilters | Gets or sets requested meta-data filter expressions to be applied by DataPublisher before meta-data is sent. | |
MetadataSynchronizationTimeout | Gets or sets the timeout used when executing database queries during meta-data synchronization. | |
MinimumMeasurementsPerSecond | Gets the minimum value of the measurements per second calculation. | |
MutualSubscription | Gets or sets flag that determines if a subscription is mutual, i.e., bi-directional pub/sub. In this mode one node will be the owner and set Internal = True and the other node will be the renter and set Internal = False. | |
Name |
Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase) | |
OperationalEncoding | Gets or sets the OperationalEncoding used by the subscriber and publisher. | |
OperationalModes | Gets or sets a set of flags that define ways in which the subscriber and publisher communicate. | |
OutputMeasurements |
Gets or sets output measurements that the AdapterBase will produce, if any.
(Overrides AdapterBaseOutputMeasurements) | |
OutputSourceIDs |
Gets or sets Source values used to filter output measurements.
(Inherited from InputAdapterBase) | |
ParsingExceptionWindow | Gets or sets time duration, in Ticks, to monitor parsing exceptions. | |
PersistConnectionForMetadata | Gets flag that indicates whether the connection will be persisted even while the adapter is offline in order to synchronize metadata. | |
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 adapter.
(Overrides AdapterBaseProcessingInterval) | |
RealTime | Gets real-time as determined by either the local clock or the latest measurement received. | |
ReceiveExternalMetadata | Gets or sets the operational mode flag to receive external meta-data. | |
ReceiveInternalMetadata | Gets or sets the operational mode flag to receive internal meta-data. | |
RequestedOutputMeasurementKeys |
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Overrides InputAdapterBaseRequestedOutputMeasurementKeys) | |
RequireAuthentication | Gets or sets flag that determines if DataPublisher requires subscribers to authenticate before making data requests. | |
RunTime |
Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase) | |
SecurityMode | Gets or sets the security mode used for communications over the command channel. | |
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 |
Gets the status of this DataSubscriber.
(Overrides InputAdapterBaseStatus) | |
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) | |
SupportsRealTimeProcessing | Gets flag indicating if this adapter supports real-time processing. | |
SupportsTemporalProcessing |
Gets the flag indicating if this adapter supports temporal processing.
(Overrides AdapterBaseSupportsTemporalProcessing) | |
TotalBytesReceived | Gets total data packet bytes received during this session. | |
UseAsyncConnect |
Gets a flag that determines if this DataSubscriber uses an asynchronous connection.
(Overrides InputAdapterBaseUseAsyncConnect) | |
UseCommonSerializationFormat | Gets or sets the operational mode flag to use the common serialization format. | |
UseLocalClockAsRealTime | Gets or sets flag that determines whether to use the local clock when calculating statistics. | |
UseMillisecondResolution | Obsolete. Gets or sets flag that informs publisher if base time-offsets can use millisecond resolution to conserve bandwidth. | |
UseSimpleTcpClient | Gets or sets flag that determines if a TcpSimpleClient should be used for connection. | |
UseSourcePrefixNames | Gets or sets flag that determines if child devices associated with a subscription should be prefixed with the subscription name and an exclamation point to ensure device name uniqueness - recommended value is true. | |
UseTransactionForMetadata | Gets or sets flag that determines if meta-data synchronization should be performed within a transaction. | |
UseZeroMQChannel | Gets or sets flag that determines if ZeroMQ should be used for command channel communications. | |
Version | Gets the version number of the protocol in use by this subscriber. |
Name | Description | |
---|---|---|
AttemptConnection |
Attempts to connect to this DataSubscriber.
(Overrides InputAdapterBaseAttemptConnection) | |
AttemptDisconnection |
Attempts to disconnect from this DataSubscriber.
(Overrides InputAdapterBaseAttemptDisconnection) | |
Authenticate | Authenticates subscriber to a data publisher. | |
Dispose |
Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase) | |
Dispose(Boolean) |
Releases the unmanaged resources used by the DataSubscriber object and optionally releases the managed resources.
(Overrides InputAdapterBaseDispose(Boolean)) | |
DisposeLocalConcentrator | Disposes of any previously defined local concentrator. | |
DumpOutageLog | Displays the contents of the outage log. | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
Finalize |
Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase) | |
GetAuthorizedSignalIDs | Returns the measurements signal IDs that were authorized after the last successful subscription request. | |
GetDataGapRecoverySubscriptionStatus | Gets the status of the temporal DataSubscriber used by the data gap recovery module. | |
GetHashCode |
Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase) | |
GetLoggingPath | Gets file path for any defined logging path. | |
GetShortStatus |
Gets a short one-line status of this DataSubscriber.
(Overrides AdapterBaseGetShortStatus(Int32)) | |
GetType | Gets the Type of the current instance. (Inherited from Object) | |
GetUnauthorizedSignalIDs | Returns the measurements signal IDs that were unauthorized after the last successful subscription request. | |
IncrementProcessedMeasurements |
Safely increments the total processed measurements.
(Inherited from AdapterBase) | |
Initialize |
Initializes DataSubscriber.
(Overrides InputAdapterBaseInitialize) | |
InterpretResponseMessage | Get message from string based response. | |
LocallySynchronizedSubscribe | Obsolete. Subscribes (or re-subscribes) to a data publisher for a locally synchronized set of data points. | |
LogDataGap | Log a data gap for data gap recovery. | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterBase) | |
OnConnected |
Called when data input source connection is established.
(Inherited from InputAdapterBase) | |
OnConnectionAuthenticated | Raises the ConnectionAuthenticated event. | |
OnConnectionEstablished | Raises the ConnectionEstablished event. | |
OnConnectionTerminated | Raises the ConnectionTerminated event. | |
OnDataStartTime | Raises the DataStartTime event. | |
OnDisconnected |
Called when data input source is disconnected.
(Inherited from InputAdapterBase) | |
OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase) | |
OnMetaDataReceived | Raises the MetaDataReceived event. | |
OnNewMeasurements |
Raises the NewMeasurements event.
(Inherited from InputAdapterBase) | |
OnNotificationReceived | Raises the NotificationReceived event. | |
OnOutputMeasurementsUpdated |
Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase) | |
OnProcessException(Exception) | Obsolete. Raises the ProcessException event. (Inherited from AdapterBase) | |
OnProcessException(MessageLevel, Exception, String, MessageFlags) |
Raises ProcessException event.
(Overrides AdapterBaseOnProcessException(MessageLevel, Exception, String, MessageFlags)) | |
OnProcessingComplete |
Raises the ProcessingComplete event.
(Inherited from InputAdapterBase) | |
OnProcessingComplete(String) | Raises the ProcessingComplete event. | |
OnReceivedServerResponse | Raises the ReceivedServerResponse event. | |
OnReceivedUserCommandResponse | Raises the ReceivedUserCommandResponse event. | |
OnServerConfigurationChanged | Raises the ServerConfigurationChanged event. | |
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) | |
RefreshMetadata | Initiate a meta-data refresh. | |
RemotelySynchronizedSubscribe | Obsolete. Subscribes (or re-subscribes) to a data publisher for a remotely synchronized set of data points. | |
RemoveDataGap | Remove a data gap from data gap recovery. | |
ResetLifetimeCounters | Resets the counters for the lifetime statistics without interrupting the adapter's operations. | |
SendServerCommand(ServerCommand, Byte) | Sends a server command to the publisher connection. | |
SendServerCommand(ServerCommand, String) | Sends a server command to the publisher connection with associated message data. | |
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 InputAdapterBase and initiates connection cycle to data input source.
(Inherited from InputAdapterBase) | |
Stop |
Stops this InputAdapterBase and disconnects from data input source.
(Inherited from InputAdapterBase) | |
Subscribe(SubscriptionInfo) | Subscribes (or re-subscribes) to a data publisher for a set of data points. | |
Subscribe(Boolean, Boolean, String) | Subscribes (or re-subscribes) to a data publisher for a set of data points. | |
SynchronizedSubscribe | Subscribes (or re-subscribes) to a data publisher for a synchronized set of data points. | |
SynchronizeMetadata | Handles meta-data synchronization to local system. | |
SynchronizeMetadata(DataSet) | Spawn meta-data synchronization. | |
ToString | Returns a string that represents the current object. (Inherited from Object) | |
Unsubscribe | Unsubscribes from a data publisher. | |
UnsynchronizedSubscribe(UnsynchronizedSubscriptionInfo) | Subscribes (or re-subscribes) to a data publisher for an unsynchronized set of data points. | |
UnsynchronizedSubscribe(Boolean, Boolean, String, String, Boolean, Double, Double, Boolean, String, String, String, Int32, String, Int32) | Obsolete. Subscribes (or re-subscribes) to a data publisher for an unsynchronized set of data points. |
Name | Description | |
---|---|---|
ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase) | |
ConnectionAuthenticated | Occurs when client connection to the data publication server has successfully authenticated. | |
ConnectionEstablished | Occurs when client connection to the data publication server is established. | |
ConnectionTerminated | Occurs when client connection to the data publication server is terminated. | |
DataStartTime | Occurs when first measurement is transmitted by data publication server. | |
Disposed |
Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase) | |
ExceededParsingExceptionThreshold | Occurs when number of parsing exceptions exceed AllowedParsingExceptions during ParsingExceptionWindow. | |
InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase) | |
MetaDataReceived | Occurs when client receives requested meta-data transmitted by data publication server. | |
NewMeasurements |
Provides new measurements from input adapter.
(Inherited from InputAdapterBase) | |
NotificationReceived | Occurs when a notification has been received from the DataPublisher. | |
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) | |
ProcessingComplete | Indicates that processing for an input adapter (via temporal session) has completed. | |
ReceivedServerResponse | Occurs when client receives response from the server. | |
ReceivedUserCommandResponse | Occurs when client receives message from the server in response to a user command. | |
ServerConfigurationChanged | Occurs when the server has sent a notification that its configuration has changed, this can allow subscriber to request updated meta-data if desired. | |
StatusMessage |
Provides status messages to consumer.
(Inherited from AdapterBase) |
Name | Description | |
---|---|---|
DefaultAllowedParsingExceptions | Specifies the default value for the AllowedParsingExceptions property. | |
DefaultLoggingPath | Default value for LoggingPath. | |
DefaultMetadataSynchronizationTimeout | Defines the default value for the MetadataSynchronizationTimeout property. | |
DefaultOperationalModes | Defines default value for OperationalModes. | |
DefaultParsingExceptionWindow | Specifies the default value for the ParsingExceptionWindow property. | |
DefaultUseTransactionForMetadata | Defines the default value for the UseTransactionForMetadata property. |
Name | Description | |
---|---|---|
GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) | |
GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |