Grid Solutions Framework Documentation
GSF Namespaces
GSF.TimeSeries.Transport
DataSubscriber Class
DataSubscriber Properties
AllowedParsingExceptions Property
Authenticated Property
AutoConnect Property
AutoSynchronizeMetadata Property
AverageMeasurementsPerSecond Property
CommandChannel Property
CommandChannelConnected Property
CompressionModes Property
CompressMetadata Property
CompressPayload Property
CompressSignalIndexCache Property
ConnectionInfo Property
DataChannel Property
DataLossInterval Property
DataSource Property
Encoding Property
LifetimeAverageLatency Property
LifetimeMaximumLatency Property
LifetimeMeasurements Property
LifetimeMinimumLatency Property
LoggingPath Property
MaximumMeasurementsPerSecond Property
MetadataFilters Property
MetadataSynchronizationTimeout Property
MinimumMeasurementsPerSecond Property
MutualSubscription Property
OperationalEncoding Property
OperationalModes Property
OutputMeasurements Property
ParsingExceptionWindow Property
PersistConnectionForMetadata Property
ProcessingInterval Property
RealTime Property
ReceiveExternalMetadata Property
ReceiveInternalMetadata Property
RequestedOutputMeasurementKeys Property
RequireAuthentication Property
SecurityMode Property
Status Property
SupportsRealTimeProcessing Property
SupportsTemporalProcessing Property
TotalBytesReceived Property
UseAsyncConnect Property
UseCommonSerializationFormat Property
UseLocalClockAsRealTime Property
UseMillisecondResolution Property
UseSimpleTcpClient Property
UseSourcePrefixNames Property
UseTransactionForMetadata Property
UseZeroMQChannel Property
Version Property
Click or drag to resize

DataSubscriber Properties

The DataSubscriber type exposes the following members.

Properties
  Name Description
Public property AllowedParsingExceptions Gets or sets number of parsing exceptions allowed during ParsingExceptionWindow before connection is reset.
Public property Authenticated Gets flag that determines if this DataSubscriber has successfully authenticated with the DataPublisher.
Public property AutoConnect Gets or sets flag that determines if DataSubscriber should attempt to auto-connection to DataPublisher using defined connection settings.
Public property AutoStart Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase)
Public property 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.
Public property AverageMeasurementsPerSecond Gets the average value of the measurements per second calculation.
Protected property CommandChannel Gets or sets reference to TcpClient command channel, attaching and/or detaching to events as needed.
Public property CommandChannelConnected Gets flag that determines whether the command channel is connected.
Public property CompressionModes Gets or sets the CompressionModes used by the subscriber and publisher.
Public property CompressMetadata Gets or sets the operational mode flag to compress meta-data.
Public property CompressPayload Gets or sets the operational mode flag to compress data payloads.
Public property CompressSignalIndexCache Gets or sets the operational mode flag to compress the signal index cache.
Protected property ConnectionAttemptInterval Gets or sets the connection attempt interval, in milliseconds, for the data input source.
(Inherited from InputAdapterBase)
Public property ConnectionInfo Gets connection info for adapter, if any.
(Overrides AdapterBaseConnectionInfo)
Public property ConnectionString Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase)
Protected property DataChannel Gets or sets reference to UdpClient data channel, attaching and/or detaching to events as needed.
Public property DataLossInterval Gets or sets data loss monitoring interval, in seconds. Set to zero to disable monitoring.
Public property DataSource Gets or sets DataSet based data source available to this DataSubscriber.
(Overrides AdapterBaseDataSource)
Protected property EnableConnectionErrors When false, connection errors do not get logged through OnProcessException. When true, connection errors will be logged normally.
(Inherited from InputAdapterBase)
Public property Enabled Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase)
Public property Encoding Gets the character encoding defined by the OperationalEncoding of the communications stream.
Public property ID Gets or sets numeric ID associated with this AdapterBase.
(Inherited from AdapterBase)
Public property InitializationTimeout Gets or sets maximum time system will wait during Start for initialization.
(Inherited from AdapterBase)
Public property Initialized Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from AdapterBase)
Public property InputMeasurementKeys Gets or sets primary keys of input measurements the AdapterBase expects, if any.
(Inherited from InputAdapterBase)
Public property IsConnected Gets flag that determines if InputAdapterBase is connected.
(Inherited from InputAdapterBase)
Public property IsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase)
Public property LifetimeAverageLatency Gets the average latency calculated over the full lifetime of the subscriber.
Public property LifetimeMaximumLatency Gets the maximum latency calculated over the full lifetime of the subscriber.
Public property LifetimeMeasurements Gets the total number of measurements processed through this data publisher over the lifetime of the subscriber.
Public property LifetimeMinimumLatency Gets the minimum latency calculated over the full lifetime of the subscriber.
Protected property Log Log messages generated by an adapter.
(Inherited from AdapterBase)
Public property 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.
Public property MaximumMeasurementsPerSecond Gets the maximum value of the measurements per second calculation.
Public property MeasurementReportingInterval Gets or sets the measurement reporting interval.
(Inherited from AdapterBase)
Public property Code example MetadataFilters Gets or sets requested meta-data filter expressions to be applied by DataPublisher before meta-data is sent.
Public property MetadataSynchronizationTimeout Gets or sets the timeout used when executing database queries during meta-data synchronization.
Public property MinimumMeasurementsPerSecond Gets the minimum value of the measurements per second calculation.
Public property 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.
Public property Name Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase)
Public property OperationalEncoding Gets or sets the OperationalEncoding used by the subscriber and publisher.
Public property OperationalModes Gets or sets a set of flags that define ways in which the subscriber and publisher communicate.
Public property OutputMeasurements Gets or sets output measurements that the AdapterBase will produce, if any.
(Overrides AdapterBaseOutputMeasurements)
Public property OutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from InputAdapterBase)
Public property ParsingExceptionWindow Gets or sets time duration, in Ticks, to monitor parsing exceptions.
Public property PersistConnectionForMetadata Gets flag that indicates whether the connection will be persisted even while the adapter is offline in order to synchronize metadata.
Public property ProcessedMeasurements Gets the total number of measurements handled thus far by the AdapterBase.
(Inherited from AdapterBase)
Public property ProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Overrides AdapterBaseProcessingInterval)
Protected property RealTime Gets real-time as determined by either the local clock or the latest measurement received.
Public property ReceiveExternalMetadata Gets or sets the operational mode flag to receive external meta-data.
Public property ReceiveInternalMetadata Gets or sets the operational mode flag to receive internal meta-data.
Public property RequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Overrides InputAdapterBaseRequestedOutputMeasurementKeys)
Public property RequireAuthentication Gets or sets flag that determines if DataPublisher requires subscribers to authenticate before making data requests.
Public property RunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase)
Public property SecurityMode Gets or sets the security mode used for communications over the command channel.
Public property Settings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase)
Public property StartTime Gets the UTC time this AdapterBase was started.
(Inherited from AdapterBase)
Public property StartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public property Status Gets the status of this DataSubscriber.
(Overrides InputAdapterBaseStatus)
Public property StopTime Gets the UTC time this AdapterBase was stopped.
(Inherited from AdapterBase)
Public property StopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public property SupportsRealTimeProcessing Gets flag indicating if this adapter supports real-time processing.
Public property SupportsTemporalProcessing Gets the flag indicating if this adapter supports temporal processing.
(Overrides AdapterBaseSupportsTemporalProcessing)
Public property TotalBytesReceived Gets total data packet bytes received during this session.
Protected property UseAsyncConnect Gets a flag that determines if this DataSubscriber uses an asynchronous connection.
(Overrides InputAdapterBaseUseAsyncConnect)
Public property UseCommonSerializationFormat Gets or sets the operational mode flag to use the common serialization format.
Public property UseLocalClockAsRealTime Gets or sets flag that determines whether to use the local clock when calculating statistics.
Public property UseMillisecondResolution Obsolete.
Gets or sets flag that informs publisher if base time-offsets can use millisecond resolution to conserve bandwidth.
Public property UseSimpleTcpClient Gets or sets flag that determines if a TcpSimpleClient should be used for connection.
Public property 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.
Public property UseTransactionForMetadata Gets or sets flag that determines if meta-data synchronization should be performed within a transaction.
Public property UseZeroMQChannel Gets or sets flag that determines if ZeroMQ should be used for command channel communications.
Public property Version Gets the version number of the protocol in use by this subscriber.
Top
See Also