|
Dnp
|
Output adapter that sends measurements to a remote DNP3 endpoint.
Inheritance Hierarchy
SystemObject
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersOutputAdapterBase
DNP3AdaptersDnp3OutputAdapter
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersOutputAdapterBase
DNP3AdaptersDnp3OutputAdapter
Namespace: DNP3Adapters
Assembly: Dnp3Adapters (in Dnp3Adapters.dll) Version: 2.4.256-beta
Syntaxpublic class Dnp3OutputAdapter : OutputAdapterBase, IDnp3Adapter, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus
The Dnp3OutputAdapter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Dnp3OutputAdapter | Creates a new Dnp3OutputAdapter. |
Properties| Name | Description | |
|---|---|---|
 | AllowUnsolicited | Gets or sets a flag that determines if unsolicited responses are allowed. |
| AutoStart |
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase) |
 | ConnectionAttemptInterval |
Gets or sets the connection attempt interval, in milliseconds, for the data output adapter.
(Inherited from OutputAdapterBase) |
| ConnectionInfo |
Gets connection info for adapter, if any.
(Inherited from AdapterBase) |
| ConnectionString |
Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase) |
| DataSource |
Gets or sets DataSet based data source available to this OutputAdapterBase.
(Inherited from OutputAdapterBase) |
| Enabled |
Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase) |
| EventsGeneratedCount | Gets the count of events generated. |
| 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 AdapterBase) |
| InputSourceIDs |
Gets or sets Source values used to filter input measurements.
(Inherited from OutputAdapterBase) |
| Interface | Gets or sets the IP address of the interface the DNP3 adapter will bind to for listening for master connections. |
| InternalProcessQueue |
Allows derived class access to internal processing queue.
(Inherited from OutputAdapterBase) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase) |
| IsMaster | Gets or sets flag that determines if the DNP3 output adapter is configured as 'master' in the link configuration. |
| KeepAliveTimeout | Gets or sets the keep-alive timeout, in milliseconds, used for the link configuration. |
| LocalAddress | Gets or sets the local address used for the link configuration. |
| Log |
Log messages generated by an adapter.
(Inherited from AdapterBase) |
| LogLevel | Gets or sets the DNP3 log level for the server connection. |
| MapStateFlagsToQuality | Gets or sets flag that determines if GSF measurement state flags should be mapped to DNP3 quality flags. |
| MaxPublishRate | Gets or sets the maximum publish rate in milliseconds. This is used to throttle event publishing to the master stations when many events are being generated. Set to zero to publish events as fast as possible. |
| MeasurementReportingInterval |
Gets or sets the measurement reporting interval.
(Inherited from AdapterBase) |
| MetadataRefreshOperation |
Gets the operation that calls ExecuteMetadataRefresh.
(Inherited from OutputAdapterBase) |
| Name |
Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase) |
| OutputIsForArchive |
Gets the flag that determines if measurements sent to this OutputAdapterBase are destined for archival.
(Overrides OutputAdapterBaseOutputIsForArchive) |
| OutputMeasurements |
Gets or sets output measurements that the AdapterBase will produce, if any.
(Inherited from OutputAdapterBase) |
| Port | Gets or sets the port the DNP3 adapter will listen for master connections on. |
| 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 output adapter.
(Inherited from OutputAdapterBase) |
| RemoteAddress | Gets or sets the remote address used for the link configuration. |
| RequestedInputMeasurementKeys |
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from OutputAdapterBase) |
| RequeueOnException |
Gets or sets whether or not to automatically place measurements back into the processing
queue if an exception occurs while processing. Defaults to false.
(Inherited from OutputAdapterBase) |
| ResponseTimeout | Gets or sets the response timeout, in milliseconds, used for the link configuration. |
| RunTime |
Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase) |
| 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) |
| StaticCacheSize | Gets the current size of the static cache. |
| StaticUpdateBatchSize | Gets or sets the batch size for static database updates. |
| StaticUpdatesCount | Gets the count of static cache updates performed. |
| Status |
Returns the detailed status of the data input source. Derived classes should extend status with implementation specific information.
(Overrides OutputAdapterBaseStatus) |
| 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) |
| SupportsTemporalProcessing |
Gets the flag indicating if this OutputAdapterBase implementation supports temporal processing.
(Inherited from OutputAdapterBase) |
| UnsolicitedClassMask | Gets or sets the unsolicited class mask. Format is four, comma separated booleans, e.g.: false, true, true, true. |
| UseAsyncConnect |
Gets flag that determines if the data output stream connects asynchronously.
(Overrides OutputAdapterBaseUseAsyncConnect) |
Methods| Name | Description | |
|---|---|---|
 | AttemptConnection |
Attempts to connect to data output stream.
(Overrides OutputAdapterBaseAttemptConnection) |
| AttemptDisconnection |
Attempts to disconnect from data output stream.
(Overrides OutputAdapterBaseAttemptDisconnection) |
| ClearStaticCache | Clears the static cache and resets statistics. |
| Dispose |
Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the Dnp3OutputAdapter object and optionally releases the managed resources.
(Overrides OutputAdapterBaseDispose(Boolean)) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteMetadataRefresh |
Executes the metadata refresh in a synchronous fashion.
(Inherited from OutputAdapterBase) |
| Finalize |
Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase) |
| Flush |
Blocks the current thread, if the OutputAdapterBase is connected, until all items
in OutputAdapterBase queue are processed, and then stops processing.
(Inherited from OutputAdapterBase) |
| GetHashCode |
Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase) |
| GetShortStatus |
Gets a short one-line status of this AdapterBase.
(Overrides AdapterBaseGetShortStatus(Int32)) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IncrementProcessedMeasurements |
Safely increments the total processed measurements.
(Inherited from AdapterBase) |
| Initialize |
Initializes OutputAdapterBase.
(Overrides OutputAdapterBaseInitialize) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterBase) |
| OnConnected |
Called when data output source connection is established.
(Inherited from OutputAdapterBase) |
| OnDisconnected |
Called when data input source is disconnected.
(Inherited from OutputAdapterBase) |
| OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase) |
| OnOutputMeasurementsUpdated |
Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase) |
| OnProcessException(Exception) | Obsolete. Raises the ProcessException event. (Inherited from AdapterBase) |
| OnProcessException(MessageLevel, Exception, String, MessageFlags) |
Raises the ProcessException event.
(Inherited from AdapterBase) |
| 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) |
| OnUnprocessedMeasurements |
Raises the UnprocessedMeasurements event.
(Inherited from OutputAdapterBase) |
| ProcessMeasurements |
Serializes measurements to data output stream.
(Overrides OutputAdapterBaseProcessMeasurements(IMeasurement)) |
| QueueMeasurementForProcessing |
Queues a single measurement for processing. Measurement is automatically filtered to the defined InputMeasurementKeys.
(Inherited from OutputAdapterBase) |
| QueueMeasurementsForProcessing |
Queues a collection of measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys.
(Inherited from OutputAdapterBase) |
| RefreshMetadata |
Initiates request for metadata refresh for OutputAdapterBase, if implemented.
(Inherited from OutputAdapterBase) |
| ReinitializeDatabase | Forces re-initialization of the DNP3 database with current cached values. |
| RemoveMeasurements |
This removes a range of measurements from the internal measurement queue.
(Inherited from OutputAdapterBase) |
| 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 OutputAdapterBase and initiates connection cycle to data output stream.
(Inherited from OutputAdapterBase) |
| Stop |
Stops this OutputAdapterBase and disconnects from data output stream.
(Inherited from OutputAdapterBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase) |
| Disposed |
Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase) |
| 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) |
| StatusMessage |
Provides status messages to consumer.
(Inherited from AdapterBase) |
| UnprocessedMeasurements |
Event is raised every five seconds allowing host to track total number of unprocessed measurements.
(Inherited from OutputAdapterBase) |
See Also