|
Data
|
Represents a data publishing server that allows multiple connections for data subscriptions.
Inheritance Hierarchy
SystemObject
System.Collections.ObjectModelCollectionIActionAdapter
GSF.CollectionsListCollectionIActionAdapter
GSF.TimeSeries.AdaptersAdapterCollectionBaseIActionAdapter
GSF.TimeSeries.AdaptersActionAdapterCollection
GSF.TimeSeries.TransportDataPublisher
System.Collections.ObjectModelCollectionIActionAdapter
GSF.CollectionsListCollectionIActionAdapter
GSF.TimeSeries.AdaptersAdapterCollectionBaseIActionAdapter
GSF.TimeSeries.AdaptersActionAdapterCollection
GSF.TimeSeries.TransportDataPublisher
Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.181-beta
Syntax[EditorBrowsableAttribute(EditorBrowsableState.Always)] public class DataPublisher : ActionAdapterCollection, IOptimizedRoutingConsumer
The DataPublisher type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataPublisher | Creates a new DataPublisher. |
Properties| Name | Description | |
|---|---|---|
 | AllowMetadataRefresh | Gets or sets flag that indicates if this publisher will allow synchronized subscriptions when requested by subscribers. |
| AllowNaNValueFilter | Gets or sets flag that indicates if this publisher will allow filtering of data which is not a number. |
| AllowPayloadCompression | Gets or sets flag that indicates if this publisher will allow payload compression when requested by subscribers. |
| AllowSynchronizedSubscription | Gets or sets flag that indicates if this publisher will allow synchronized subscriptions when requested by subscribers. |
 | AutoInitialize |
Gets flag that determines if DataPublisher subscriptions
are automatically initialized when they are added to the collection.
(Overrides AdapterCollectionBaseTAutoInitialize) |
| AutoStart |
Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false.
(Inherited from AdapterCollectionBaseT) |
| AverageMeasurementsPerSecond | Gets the average value of the measurements per second calculation. |
| BufferBlockRetransmissions | Gets the total number of buffer block retransmissions on all subscriptions over the lifetime of the publisher. |
| CacheMeasurementKeys | Gets or sets the set of measurements which are cached by the data publisher to be published to subscribers immediately upon subscription. |
| CipherKeyRotationPeriod | Gets or sets the cipher key rotation period. |
| ClientConnections | Gets dictionary of connected clients. |
| CommandChannel | Gets or sets reference to TcpServer command channel, attaching and/or detaching to events as needed. |
| CompressionStrength | Gets or sets the compression strength value to use when compressing data for subscribers. |
| ConnectionString |
Gets or sets key/value pair connection information specific to this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT) |
| ConvertReadonlyCollectionsToWritable |
Gets or sets flag that determines if readonly collections should be converted
to writable so published measurement sets can be augmented by filter adapters.
(Inherited from ActionAdapterCollection) |
| Count |
Gets the number of elements contained in the ICollectionT.
(Inherited from ListCollectionT) |
| DataMember |
Gets or sets specific data member (e.g., table name) in DataSource used to Initialize this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT) |
| DataSource |
Gets or sets DataSet based data source used to load each IAdapter.
Updates to this property will cascade to all items in this AdapterCollectionBaseT.
(Overrides AdapterCollectionBaseTDataSource) |
| Enabled |
Gets or sets enabled state of this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT) |
| EncryptPayload | Gets or sets flag that determines whether data sent over the data channel should be encrypted. |
| ForceNaNValueFilter | Gets or sets flag that indicates if this publisher will force filtering of data which is not a number. |
| ID |
Gets or sets numeric ID associated with this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT) |
| InitializationTimeout |
Gets or sets the default adapter time that represents the maximum time system will wait during Start for initialization.
(Inherited from AdapterCollectionBaseT) |
| Initialized |
Gets or sets flag indicating if the adapter collection has been initialized successfully.
(Inherited from AdapterCollectionBaseT) |
| InputMeasurementKeys |
Gets or sets primary keys of input measurements the AdapterCollectionBaseT expects, if any.
(Inherited from AdapterCollectionBaseT) |
| InputSourceIDs |
Gets or sets Source values used to filter input measurement keys.
(Inherited from AdapterCollectionBaseT) |
| IsConnected | Gets flag indicating if publisher is connected and listening. |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterCollectionBaseT) |
| IsReadOnly |
Gets a value indicating whether the AdapterCollectionBaseT is read-only.
(Inherited from AdapterCollectionBaseT) |
| Item |
Gets or sets the element at the specified index.
(Inherited from ListCollectionT) |
| Items |
Gets a IListT wrapper around the CollectionT.
(Inherited from ListCollectionT) |
| LifetimeAverageLatency | Gets the average latency calculated over the full lifetime of the publisher. |
| LifetimeMaximumLatency | Gets the maximum latency calculated over the full lifetime of the publisher. |
| LifetimeMeasurements | Gets the total number of measurements processed through this data publisher over the lifetime of the publisher. |
| LifetimeMinimumLatency | Gets the minimum latency calculated over the full lifetime of the publisher. |
| Log |
Log messages generated by an adapter.
(Inherited from AdapterCollectionBaseT) |
| MaximumMeasurementsPerSecond | Gets the maximum value of the measurements per second calculation. |
| MeasurementReportingInterval | Gets or sets the measurement reporting interval. |
| MetadataTables | Gets or sets semi-colon separated list of SQL select statements used to create data for meta-data exchange. |
| MinimumMeasurementsPerSecond | Gets the minimum value of the measurements per second calculation. |
| MonitorTimerEnabled |
Gets or sets flag that determines if monitor timer should be used for monitoring processed measurement statistics for the AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT) |
| 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 DataPublisher.
(Overrides AdapterCollectionBaseTName) |
| OutputMeasurements |
Gets or sets output measurements that the AdapterCollectionBaseT will produce, if any.
(Inherited from AdapterCollectionBaseT) |
| OutputSourceIDs |
Gets or sets Source values used to filter output measurements.
(Inherited from AdapterCollectionBaseT) |
| ProcessedMeasurements |
Gets the total number of measurements processed thus far by each IAdapter implementation
in the AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT) |
| ProcessingInterval |
Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter.
(Inherited from AdapterCollectionBaseT) |
| RequestedInputMeasurementKeys |
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBaseT) |
| RequestedOutputMeasurementKeys |
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBaseT) |
| RequireAuthentication | Gets or sets flag that determines if DataPublisher should require subscribers to authenticate before making data requests. |
| RespectInputDemands |
Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
(Inherited from ActionAdapterCollection) |
| RespectOutputDemands |
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
(Inherited from ActionAdapterCollection) |
| RunTime |
Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterCollectionBaseT) |
| SecurityMode | Gets or sets the security mode of the DataPublisher's command channel. |
| Settings |
Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterCollectionBaseT) |
| SharedDatabase | Gets or sets flag that indicates whether this publisher is publishing data that this node subscribed to from another node in a shared database. |
| StartTime |
Gets the UTC time this AdapterCollectionBaseT was started.
(Inherited from AdapterCollectionBaseT) |
| StartTimeConstraint |
Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBaseT) |
| Status |
Gets the status of this DataPublisher.
(Overrides ActionAdapterCollectionStatus) |
| StopTime |
Gets the UTC time this AdapterCollectionBaseT was stopped.
(Inherited from AdapterCollectionBaseT) |
| StopTimeConstraint |
Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBaseT) |
| SupportsTemporalProcessing |
Gets the flag indicating if this adapter collection supports temporal processing.
(Inherited from AdapterCollectionBaseT) |
| TotalBytesSent | Gets the total number of bytes sent to clients of this data publisher. |
| UseBaseTimeOffsets | Gets or sets flag that determines whether to use base time offsets to decrease the size of compact measurements. |
| UseZeroMQChannel | Gets or sets flag that determines if ZeroMQ should be used for command channel communications. |
Methods| Name | Description | |
|---|---|---|
| Add |
Adds an item to the ICollectionT.
(Inherited from ListCollectionT) |
 | AquireMetadata | Gets meta-data to return to DataSubscriber. |
| Clear |
Removes all items from the ICollectionT.
(Inherited from ListCollectionT) |
| ClearItems |
Removes all elements from the CollectionT.
(Inherited from AdapterCollectionBaseT) |
| Contains |
Determines whether the ICollectionT contains a specific value.
(Inherited from ListCollectionT) |
| CopyTo |
Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from ListCollectionT) |
| Dispose |
Releases all the resources used by the AdapterCollectionBaseT object.
(Inherited from AdapterCollectionBaseT) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the DataPublisher object and optionally releases the managed resources.
(Overrides AdapterCollectionBaseTDispose(Boolean)) |
| DisposeItem |
Unwires events and disposes of IActionAdapter implementation.
(Inherited from ActionAdapterCollection) |
| EnumerateClients | Enumerates connected clients. |
| EnumerateTemporalClients | Enumerates connected clients with active temporal sessions. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the DataPublisher object is reclaimed by GC.
(Overrides AdapterCollectionBaseTFinalize) |
| GetClientEncoding | Gets the text encoding associated with a particular client. |
| GetEnumerator |
Returns an enumerator that iterates through the CollectionT.
(Inherited from ListCollectionT) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLocalCertificate | Gets the local certificate currently in use by the data publisher. |
| GetShortStatus |
Gets a short one-line status of this DataPublisher.
(Overrides AdapterCollectionBaseTGetShortStatus(Int32)) |
| GetSubscriberInfo | Gets subscriber information for specified client connection. |
| GetSubscriberStatus | Gets subscriber status for specified subscriber ID. |
| GetTemporalStatus | Gets temporal status for a specified client connection. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HandleUserCommand | Handles custom commands defined by the user of the publisher API. |
| ImportCertificate | Imports a certificate to the trusted certificates path. |
| IndexOf |
Determines the index of a specific item in the IListT.
(Inherited from ListCollectionT) |
| Initialize |
Initializes DataPublisher.
(Overrides ActionAdapterCollectionInitialize) |
| InitializeItem |
Wires events and initializes new IActionAdapter implementation.
(Inherited from ActionAdapterCollection) |
| Insert |
Inserts an item to the IListT at the specified index.
(Inherited from ListCollectionT) |
| InsertItem |
Inserts an element into the CollectionT the specified index.
(Inherited from AdapterCollectionBaseT) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnClientConnected | Raises the ClientConnected event. |
| OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterCollectionBaseT) |
| OnDiscardingMeasurements |
Raises the DiscardingMeasurements event.
(Inherited from ActionAdapterCollection) |
| OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterCollectionBaseT) |
| OnNewMeasurements(ICollectionIMeasurement) |
Raises the NewMeasurements event.
(Inherited from ActionAdapterCollection) |
| OnNewMeasurements(Object, EventArgsICollectionIMeasurement) |
Raises the NewMeasurements event.
(Inherited from ActionAdapterCollection) |
| OnOutputMeasurementsUpdated |
Raises OutputMeasurementsUpdated event.
(Inherited from AdapterCollectionBaseT) |
| OnProcessException(Exception) | Obsolete. Raises the ProcessException event. (Inherited from AdapterCollectionBaseT) |
| OnProcessException(MessageLevel, Exception, String, MessageFlags) |
Raises the ProcessException event.
(Inherited from AdapterCollectionBaseT) |
| OnProcessingComplete | Raises the ProcessingComplete event. |
| OnRequestTemporalSupport |
Raises RequestTemporalSupport event.
(Inherited from ActionAdapterCollection) |
| OnStatusMessage(String) | Obsolete. Raises the StatusMessage event. (Inherited from AdapterCollectionBaseT) |
| OnStatusMessage(String, Object) | Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterCollectionBaseT) |
| OnStatusMessage(MessageLevel, String, String, MessageFlags) |
Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterCollectionBaseT) |
| OnUnpublishedSamples |
Raises the UnpublishedSamples event.
(Inherited from ActionAdapterCollection) |
| QueueMeasurementsForProcessing |
Queues a collection of measurements for processing to each IActionAdapter connected to this DataPublisher.
(Overrides ActionAdapterCollectionQueueMeasurementsForProcessing(IEnumerableIMeasurement)) |
| Remove |
Removes the first occurrence of a specific object from the ICollectionT.
(Inherited from ListCollectionT) |
| RemoveAt |
Removes the element at the specified index of the CollectionT.
(Inherited from ListCollectionT) |
| RemoveItem |
Removes the element at the specified index of the CollectionT.
(Inherited from AdapterCollectionBaseT) |
| ResetLifetimeCounters | Resets the counters for the lifetime statistics without interrupting the adapter's operations. |
| ResetStatistics |
Resets the statistics of this collection.
(Inherited from AdapterCollectionBaseT) |
| RotateCipherKeys | Rotates cipher keys for specified client connection. |
| SendClientResponse(Guid, ServerResponse, ServerCommand) | Sends response back to specified client. |
| SendClientResponse(Guid, ServerResponse, ServerCommand, Byte) | Sends response back to specified client with attached data. |
| SendClientResponse(Guid, ServerResponse, ServerCommand, String) | Sends response back to specified client with a message. |
| SendClientResponse(Guid, ServerResponse, ServerCommand, String, Object) | Sends response back to specified client with a formatted message. |
| SendDataStartTime | Sends the start time of the first measurement in a connection transmission. |
| SendNotification | Sends a notification to all subscribers. |
| SetItem |
Assigns a new element to the CollectionT at the specified index.
(Inherited from AdapterCollectionBaseT) |
| SetTemporalConstraint |
Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter.
(Inherited from AdapterCollectionBaseT) |
| Start |
Establish DataPublisher and start listening for client connections.
(Overrides AdapterCollectionBaseTStart) |
| Stop |
Terminate DataPublisher and stop listening for client connections.
(Overrides AdapterCollectionBaseTStop) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryCreateAdapter |
Attempts to create an IAdapter from the specified DataRow.
(Inherited from AdapterCollectionBaseT) |
| TryGetAdapterTValue |
Attempts to get the adapter with the specified value given testItem function.
(Inherited from AdapterCollectionBaseT) |
| TryGetAdapterByID |
Attempts to get the adapter with the specified id.
(Inherited from AdapterCollectionBaseT) |
| TryGetAdapterByName |
Attempts to get the adapter with the specified name.
(Inherited from AdapterCollectionBaseT) |
| TryInitializeAdapterByID |
Attempts to initialize (or reinitialize) an individual IAdapter based on its ID.
(Inherited from AdapterCollectionBaseT) |
| UpdateLatencyStatistics | Updates latency statistics based on the collection of latencies passed into the method. |
| UpdateLatestMeasurementCache | Updates the latest measurement cache when the set of cached measurements may have changed. |
| UpdateRights | Updates each subscription's inputs based on possible updates to that subscriber's rights. |
| UpdateSignalIndexCache | Updates signal index cache based on input measurement keys. |
Events| Name | Description | |
|---|---|---|
 | ClientConnected | Indicates that a new client has connected to the publisher. |
| ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterCollectionBaseT) |
| DiscardingMeasurements |
This event is raised if there are any measurements being discarded during the sorting process.
(Inherited from ActionAdapterCollection) |
| Disposed |
Event is raised when this AdapterCollectionBaseT is disposed or an IAdapter in the collection is disposed.
(Inherited from AdapterCollectionBaseT) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterCollectionBaseT) |
| NewMeasurements |
This event will be raised when there are new measurements available from the action adapter.
(Inherited from ActionAdapterCollection) |
| OutputMeasurementsUpdated |
Event is raised when OutputMeasurements are updated.
(Inherited from AdapterCollectionBaseT) |
| ProcessException |
Event is raised when there is an exception encountered while processing.
(Inherited from AdapterCollectionBaseT) |
| ProcessingComplete | Indicates to the host that processing for an input adapter (via temporal session) has completed. |
| RequestTemporalSupport |
Event is raised when temporal support is requested.
(Inherited from ActionAdapterCollection) |
| StatusMessage |
Provides status messages to consumer.
(Inherited from AdapterCollectionBaseT) |
| UnpublishedSamples |
This event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.
(Inherited from ActionAdapterCollection) |
FieldsTop
Extension Methods| 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) |
See Also