Click or drag to resize

DataSubscriber Methods

The DataSubscriber type exposes the following members.

Methods
  Name Description
Protected method AttemptConnection Attempts to connect to this DataSubscriber.
(Overrides InputAdapterBaseAttemptConnection)
Protected method AttemptDisconnection Attempts to disconnect from this DataSubscriber.
(Overrides InputAdapterBaseAttemptDisconnection)
Public method Authenticate Authenticates subscriber to a data publisher.
Public method Dispose Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the DataSubscriber object and optionally releases the managed resources.
(Overrides InputAdapterBaseDispose(Boolean))
Protected method DisposeLocalConcentrator Disposes of any previously defined local concentrator.
Public method DumpOutageLog Displays the contents of the outage log.
Public method Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
Protected method Finalize Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase)
Public method GetAuthorizedSignalIDs Returns the measurements signal IDs that were authorized after the last successful subscription request.
Public method GetDataGapRecoverySubscriptionStatus Gets the status of the temporal DataSubscriber used by the data gap recovery module.
Public method GetHashCode Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase)
Protected method GetLoggingPath Gets file path for any defined logging path.
Public method GetShortStatus Gets a short one-line status of this DataSubscriber.
(Overrides AdapterBaseGetShortStatus(Int32))
Public method GetType Gets the Type of the current instance.
(Inherited from Object)
Public method GetUnauthorizedSignalIDs Returns the measurements signal IDs that were unauthorized after the last successful subscription request.
Protected method IncrementProcessedMeasurements Safely increments the total processed measurements.
(Inherited from AdapterBase)
Public method Initialize Initializes DataSubscriber.
(Overrides InputAdapterBaseInitialize)
Protected method InterpretResponseMessage Get message from string based response.
Public method LocallySynchronizedSubscribe Obsolete.
Subscribes (or re-subscribes) to a data publisher for a locally synchronized set of data points.
Public method LogDataGap Log a data gap for data gap recovery.
Protected method MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Protected method OnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterBase)
Protected method OnConnected Called when data input source connection is established.
(Inherited from InputAdapterBase)
Protected method OnConnectionAuthenticated Raises the ConnectionAuthenticated event.
Protected method OnConnectionEstablished Raises the ConnectionEstablished event.
Protected method OnConnectionTerminated Raises the ConnectionTerminated event.
Protected method OnDataStartTime Raises the DataStartTime event.
Protected method OnDisconnected Called when data input source is disconnected.
(Inherited from InputAdapterBase)
Protected method OnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase)
Protected method OnMetaDataReceived Raises the MetaDataReceived event.
Protected method OnNewMeasurements Raises the NewMeasurements event.
(Inherited from InputAdapterBase)
Protected method OnNotificationReceived Raises the NotificationReceived event.
Protected method OnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase)
Protected method OnProcessException(Exception) Obsolete.
Raises the ProcessException event.
(Inherited from AdapterBase)
Protected method OnProcessException(MessageLevel, Exception, String, MessageFlags) Raises ProcessException event.
(Overrides AdapterBaseOnProcessException(MessageLevel, Exception, String, MessageFlags))
Protected method OnProcessingComplete Raises the ProcessingComplete event.
(Inherited from InputAdapterBase)
Protected method OnProcessingComplete(String) Raises the ProcessingComplete event.
Protected method OnReceivedServerResponse Raises the ReceivedServerResponse event.
Protected method OnReceivedUserCommandResponse Raises the ReceivedUserCommandResponse event.
Protected method OnServerConfigurationChanged Raises the ServerConfigurationChanged event.
Protected method OnStatusMessage(String) Obsolete.
Raises the StatusMessage event.
(Inherited from AdapterBase)
Protected method OnStatusMessage(String, Object) Obsolete.
Raises the StatusMessage event with a formatted status message.
(Inherited from AdapterBase)
Protected method OnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterBase)
Public method RefreshMetadata Initiate a meta-data refresh.
Public method RemotelySynchronizedSubscribe Obsolete.
Subscribes (or re-subscribes) to a data publisher for a remotely synchronized set of data points.
Public method RemoveDataGap Remove a data gap from data gap recovery.
Public method ResetLifetimeCounters Resets the counters for the lifetime statistics without interrupting the adapter's operations.
Public method SendServerCommand(ServerCommand, Byte) Sends a server command to the publisher connection.
Public method SendServerCommand(ServerCommand, String) Sends a server command to the publisher connection with associated message data.
Public method SetInitializedState Manually sets the initialized state of the AdapterBase.
(Inherited from AdapterBase)
Public method SetTemporalConstraint Defines a temporal processing constraint for the adapter.
(Inherited from AdapterBase)
Public method Start Starts this InputAdapterBase and initiates connection cycle to data input source.
(Inherited from InputAdapterBase)
Public method Stop Stops this InputAdapterBase and disconnects from data input source.
(Inherited from InputAdapterBase)
Public method Subscribe(SubscriptionInfo) Subscribes (or re-subscribes) to a data publisher for a set of data points.
Public method Subscribe(Boolean, Boolean, String) Subscribes (or re-subscribes) to a data publisher for a set of data points.
Public method SynchronizedSubscribe Subscribes (or re-subscribes) to a data publisher for a synchronized set of data points.
Protected method SynchronizeMetadata Handles meta-data synchronization to local system.
Public method SynchronizeMetadata(DataSet) Spawn meta-data synchronization.
Public method ToString Returns a string that represents the current object.
(Inherited from Object)
Public method Unsubscribe Unsubscribes from a data publisher.
Public method UnsynchronizedSubscribe(UnsynchronizedSubscriptionInfo) Subscribes (or re-subscribes) to a data publisher for an unsynchronized set of data points.
Public method 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.
Top
Extension Methods
  Name Description
Public Extension Method GetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension Method GetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also