Click or drag to resize

DataSubscriber Class

Represents a data subscribing client that will connect to a data publisher for a data subscription.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersInputAdapterBase
      GSF.TimeSeries.TransportDataSubscriber

Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.177-beta
Syntax
[EditorBrowsableAttribute(EditorBrowsableState.Advanced)]
public class DataSubscriber : InputAdapterBase
View Source

The DataSubscriber type exposes the following members.

Constructors
 NameDescription
Public methodDataSubscriber Creates a new DataSubscriber.
Top
Properties
 NameDescription
Public propertyAllowedParsingExceptions Gets or sets number of parsing exceptions allowed during ParsingExceptionWindow before connection is reset.
Public propertyAuthenticated Gets flag that determines if this DataSubscriber has successfully authenticated with the DataPublisher.
Public propertyAutoConnect Gets or sets flag that determines if DataSubscriber should attempt to auto-connection to DataPublisher using defined connection settings.
Public propertyAutoStart Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase)
Public propertyAutoSynchronizeMetadata Gets or sets flag that determines if DataSubscriber should automatically request meta-data synchronization and synchronize publisher meta-data with its own database configuration.
Public propertyAverageMeasurementsPerSecond Gets the average value of the measurements per second calculation.
Protected propertyCommandChannel Gets or sets reference to TcpClient command channel, attaching and/or detaching to events as needed.
Public propertyCommandChannelConnected Gets flag that determines whether the command channel is connected.
Public propertyCompressionModes Gets or sets the CompressionModes used by the subscriber and publisher.
Public propertyCompressMetadata Gets or sets the operational mode flag to compress meta-data.
Public propertyCompressPayload Gets or sets the operational mode flag to compress data payloads.
Public propertyCompressSignalIndexCache Gets or sets the operational mode flag to compress the signal index cache.
Protected propertyConnectionAttemptInterval Gets or sets the connection attempt interval, in milliseconds, for the data input source.
(Inherited from InputAdapterBase)
Public propertyConnectionInfo Gets connection info for adapter, if any.
(Overrides AdapterBaseConnectionInfo)
Public propertyConnectionString Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase)
Protected propertyDataChannel Gets or sets reference to UdpClient data channel, attaching and/or detaching to events as needed.
Public propertyDataLossInterval Gets or sets data loss monitoring interval, in seconds. Set to zero to disable monitoring.
Public propertyDataSource Gets or sets DataSet based data source available to this DataSubscriber.
(Overrides AdapterBaseDataSource)
Protected propertyEnableConnectionErrors When false, connection errors do not get logged through OnProcessException. When true, connection errors will be logged normally.
(Inherited from InputAdapterBase)
Public propertyEnabled Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase)
Public propertyEncoding Gets the character encoding defined by the OperationalEncoding of the communications stream.
Public propertyID Gets or sets numeric ID associated with this AdapterBase.
(Inherited from AdapterBase)
Public propertyInitializationTimeout Gets or sets maximum time system will wait during Start for initialization.
(Inherited from AdapterBase)
Public propertyInitialized Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from AdapterBase)
Public propertyInputMeasurementKeys Gets or sets primary keys of input measurements the AdapterBase expects, if any.
(Inherited from InputAdapterBase)
Public propertyIsConnected Gets flag that determines if InputAdapterBase is connected.
(Inherited from InputAdapterBase)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase)
Public propertyLifetimeAverageLatency Gets the average latency calculated over the full lifetime of the subscriber.
Public propertyLifetimeMaximumLatency Gets the maximum latency calculated over the full lifetime of the subscriber.
Public propertyLifetimeMeasurements Gets the total number of measurements processed through this data publisher over the lifetime of the subscriber.
Public propertyLifetimeMinimumLatency Gets the minimum latency calculated over the full lifetime of the subscriber.
Protected propertyLog Log messages generated by an adapter.
(Inherited from AdapterBase)
Public propertyLoggingPath Gets or sets logging path to be used to be runtime and outage logs of the subscriber which are required for automated data recovery.
Public propertyMaximumMeasurementsPerSecond Gets the maximum value of the measurements per second calculation.
Public propertyMeasurementReportingInterval Gets or sets the measurement reporting interval.
(Inherited from AdapterBase)
Public propertyCode exampleMetadataFilters Gets or sets requested meta-data filter expressions to be applied by DataPublisher before meta-data is sent.
Public propertyMetadataSynchronizationTimeout Gets or sets the timeout used when executing database queries during meta-data synchronization.
Public propertyMinimumMeasurementsPerSecond Gets the minimum value of the measurements per second calculation.
Public propertyMutualSubscription 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.
Public propertyName Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase)
Public propertyOperationalEncoding Gets or sets the OperationalEncoding used by the subscriber and publisher.
Public propertyOperationalModes Gets or sets a set of flags that define ways in which the subscriber and publisher communicate.
Public propertyOutputMeasurements Gets or sets output measurements that the AdapterBase will produce, if any.
(Overrides AdapterBaseOutputMeasurements)
Public propertyOutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from InputAdapterBase)
Public propertyParsingExceptionWindow Gets or sets time duration, in Ticks, to monitor parsing exceptions.
Public propertyPersistConnectionForMetadata Gets flag that indicates whether the connection will be persisted even while the adapter is offline in order to synchronize metadata.
Public propertyProcessedMeasurements Gets the total number of measurements handled thus far by the AdapterBase.
(Inherited from AdapterBase)
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Overrides AdapterBaseProcessingInterval)
Protected propertyRealTime Gets real-time as determined by either the local clock or the latest measurement received.
Public propertyReceiveExternalMetadata Gets or sets the operational mode flag to receive external meta-data.
Public propertyReceiveInternalMetadata Gets or sets the operational mode flag to receive internal meta-data.
Public propertyRequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Overrides InputAdapterBaseRequestedOutputMeasurementKeys)
Public propertyRequireAuthentication Gets or sets flag that determines if DataPublisher requires subscribers to authenticate before making data requests.
Public propertyRunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase)
Public propertySecurityMode Gets or sets the security mode used for communications over the command channel.
Public propertySettings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase)
Public propertyStartTime Gets the UTC time this AdapterBase was started.
(Inherited from AdapterBase)
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertyStatus Gets the status of this DataSubscriber.
(Overrides InputAdapterBaseStatus)
Public propertyStopTime Gets the UTC time this AdapterBase was stopped.
(Inherited from AdapterBase)
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertySupportsRealTimeProcessing Gets flag indicating if this adapter supports real-time processing.
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter supports temporal processing.
(Overrides AdapterBaseSupportsTemporalProcessing)
Public propertyTotalBytesReceived Gets total data packet bytes received during this session.
Protected propertyUseAsyncConnect Gets a flag that determines if this DataSubscriber uses an asynchronous connection.
(Overrides InputAdapterBaseUseAsyncConnect)
Public propertyUseCommonSerializationFormat Gets or sets the operational mode flag to use the common serialization format.
Public propertyUseLocalClockAsRealTime Gets or sets flag that determines whether to use the local clock when calculating statistics.
Public propertyUseMillisecondResolutionObsolete.
Gets or sets flag that informs publisher if base time-offsets can use millisecond resolution to conserve bandwidth.
Public propertyUseSimpleTcpClient Gets or sets flag that determines if a TcpSimpleClient should be used for connection.
Public propertyUseSourcePrefixNames 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.
Public propertyUseTransactionForMetadata Gets or sets flag that determines if meta-data synchronization should be performed within a transaction.
Public propertyUseZeroMQChannel Gets or sets flag that determines if ZeroMQ should be used for command channel communications.
Public propertyVersion Gets the version number of the protocol in use by this subscriber.
Top
Methods
 NameDescription
Protected methodAttemptConnection Attempts to connect to this DataSubscriber.
(Overrides InputAdapterBaseAttemptConnection)
Protected methodAttemptDisconnection Attempts to disconnect from this DataSubscriber.
(Overrides InputAdapterBaseAttemptDisconnection)
Public methodAuthenticate Authenticates subscriber to a data publisher.
Public methodDispose Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the DataSubscriber object and optionally releases the managed resources.
(Overrides InputAdapterBaseDispose(Boolean))
Protected methodDisposeLocalConcentrator Disposes of any previously defined local concentrator.
Public methodDumpOutageLog Displays the contents of the outage log.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase)
Public methodGetAuthorizedSignalIDs Returns the measurements signal IDs that were authorized after the last successful subscription request.
Public methodGetDataGapRecoverySubscriptionStatus Gets the status of the temporal DataSubscriber used by the data gap recovery module.
Public methodGetHashCode Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase)
Protected methodGetLoggingPath Gets file path for any defined logging path.
Public methodGetShortStatus Gets a short one-line status of this DataSubscriber.
(Overrides AdapterBaseGetShortStatus(Int32))
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetUnauthorizedSignalIDs Returns the measurements signal IDs that were unauthorized after the last successful subscription request.
Protected methodIncrementProcessedMeasurements Safely increments the total processed measurements.
(Inherited from AdapterBase)
Public methodInitialize Initializes DataSubscriber.
(Overrides InputAdapterBaseInitialize)
Protected methodInterpretResponseMessage Get message from string based response.
Public methodLocallySynchronizedSubscribeObsolete.
Subscribes (or re-subscribes) to a data publisher for a locally synchronized set of data points.
Public methodLogDataGap Log a data gap for data gap recovery.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterBase)
Protected methodOnConnected Called when data input source connection is established.
(Inherited from InputAdapterBase)
Protected methodOnConnectionAuthenticated Raises the ConnectionAuthenticated event.
Protected methodOnConnectionEstablished Raises the ConnectionEstablished event.
Protected methodOnConnectionTerminated Raises the ConnectionTerminated event.
Protected methodOnDataStartTime Raises the DataStartTime event.
Protected methodOnDisconnected Called when data input source is disconnected.
(Inherited from InputAdapterBase)
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase)
Protected methodOnMetaDataReceived Raises the MetaDataReceived event.
Protected methodOnNewMeasurements Raises the NewMeasurements event.
(Inherited from InputAdapterBase)
Protected methodOnNotificationReceived Raises the NotificationReceived event.
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase)
Protected methodOnProcessException(Exception)Obsolete.
Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnProcessException(MessageLevel, Exception, String, MessageFlags) Raises ProcessException event.
(Overrides AdapterBaseOnProcessException(MessageLevel, Exception, String, MessageFlags))
Protected methodOnProcessingComplete Raises the ProcessingComplete event.
(Inherited from InputAdapterBase)
Protected methodOnProcessingComplete(String) Raises the ProcessingComplete event.
Protected methodOnReceivedServerResponse Raises the ReceivedServerResponse event.
Protected methodOnReceivedUserCommandResponse Raises the ReceivedUserCommandResponse event.
Protected methodOnServerConfigurationChanged Raises the ServerConfigurationChanged event.
Protected methodOnStatusMessage(String)Obsolete.
Raises the StatusMessage event.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(String, Object)Obsolete.
Raises the StatusMessage event with a formatted status message.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterBase)
Public methodRefreshMetadata Initiate a meta-data refresh.
Public methodRemotelySynchronizedSubscribeObsolete.
Subscribes (or re-subscribes) to a data publisher for a remotely synchronized set of data points.
Public methodRemoveDataGap Remove a data gap from data gap recovery.
Public methodResetLifetimeCounters Resets the counters for the lifetime statistics without interrupting the adapter's operations.
Public methodSendServerCommand(ServerCommand, Byte) Sends a server command to the publisher connection.
Public methodSendServerCommand(ServerCommand, String) Sends a server command to the publisher connection with associated message data.
Public methodSetInitializedState Manually sets the initialized state of the AdapterBase.
(Inherited from AdapterBase)
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter.
(Inherited from AdapterBase)
Public methodStart Starts this InputAdapterBase and initiates connection cycle to data input source.
(Inherited from InputAdapterBase)
Public methodStop Stops this InputAdapterBase and disconnects from data input source.
(Inherited from InputAdapterBase)
Public methodSubscribe(SubscriptionInfo) Subscribes (or re-subscribes) to a data publisher for a set of data points.
Public methodSubscribe(Boolean, Boolean, String) Subscribes (or re-subscribes) to a data publisher for a set of data points.
Public methodSynchronizedSubscribe Subscribes (or re-subscribes) to a data publisher for a synchronized set of data points.
Protected methodSynchronizeMetadata Handles meta-data synchronization to local system.
Public methodSynchronizeMetadata(DataSet) Spawn meta-data synchronization.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUnsubscribe Unsubscribes from a data publisher.
Public methodUnsynchronizedSubscribe(UnsynchronizedSubscriptionInfo) Subscribes (or re-subscribes) to a data publisher for an unsynchronized set of data points.
Public methodUnsynchronizedSubscribe(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.
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase)
Public eventConnectionAuthenticated Occurs when client connection to the data publication server has successfully authenticated.
Public eventConnectionEstablished Occurs when client connection to the data publication server is established.
Public eventConnectionTerminated Occurs when client connection to the data publication server is terminated.
Public eventDataStartTime Occurs when first measurement is transmitted by data publication server.
Public eventDisposed Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase)
Public eventExceededParsingExceptionThreshold Occurs when number of parsing exceptions exceed AllowedParsingExceptions during ParsingExceptionWindow.
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase)
Public eventMetaDataReceived Occurs when client receives requested meta-data transmitted by data publication server.
Public eventNewMeasurements Provides new measurements from input adapter.
(Inherited from InputAdapterBase)
Public eventNotificationReceived Occurs when a notification has been received from the DataPublisher.
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from AdapterBase)
Public eventProcessException Event is raised when there is an exception encountered while processing.
(Inherited from AdapterBase)
Public eventProcessingComplete Indicates that processing for an input adapter (via temporal session) has completed.
Public eventReceivedServerResponse Occurs when client receives response from the server.
Public eventReceivedUserCommandResponse Occurs when client receives message from the server in response to a user command.
Public eventServerConfigurationChanged Occurs when the server has sent a notification that its configuration has changed, this can allow subscriber to request updated meta-data if desired.
Public eventStatusMessage Provides status messages to consumer.
(Inherited from AdapterBase)
Top
Fields
 NameDescription
Public fieldStatic memberDefaultAllowedParsingExceptions Specifies the default value for the AllowedParsingExceptions property.
Public fieldStatic memberDefaultLoggingPath Default value for LoggingPath.
Public fieldStatic memberDefaultMetadataSynchronizationTimeout Defines the default value for the MetadataSynchronizationTimeout property.
Public fieldStatic memberDefaultOperationalModes Defines default value for OperationalModes.
Public fieldStatic memberDefaultParsingExceptionWindow Specifies the default value for the ParsingExceptionWindow property.
Public fieldStatic memberDefaultUseTransactionForMetadata Defines the default value for the UseTransactionForMetadata property.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also