|
IData
|
Defines a web service that can send and receive historian data over REST (Representational State Transfer) interface.
Namespace: GSF.Historian.DataServices
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.218-beta
Syntaxpublic interface IDataService : ISelfHostingService, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, IPersistSettings
The IDataService type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archive | Gets or sets the IArchive used by the web service for its data. |
| ContractInterface |
Gets or sets the FullName of the contract interface implemented by the web service.
(Inherited from ISelfHostingService) |
| Domain |
Gets the AppDomain in which the IAdapter is executing.
(Inherited from IAdapter) |
| Enabled |
Gets or sets a boolean value that indicates whether the object is enabled.
(Inherited from ISupportLifecycle) |
| Endpoints |
Gets or sets a semicolon delimited list of URIs where the web service can be accessed.
(Inherited from ISelfHostingService) |
| HostFile |
Gets or sets the path to the file where the IAdapter is housed.
(Inherited from IAdapter) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from ISupportLifecycle) |
| MemoryUsage |
Gets the memory utilization of the IAdapter in bytes if executing in a separate AppDomain, otherwise NaN.
(Inherited from IAdapter) |
| Name |
Gets the name of the object providing status information.
(Inherited from IProvideStatus) |
| PersistSettings |
Determines whether the object settings are to be persisted to the config file.
(Inherited from IPersistSettings) |
| ProcessorUsage |
Gets the % processor utilization of the IAdapter if executing in a separate AppDomain otherwise NaN.
(Inherited from IAdapter) |
| PublishMetadata |
Gets or sets a boolean value that indicates whether web service metadata is to made available at all web service Endpoints.
(Inherited from ISelfHostingService) |
| SecurityPolicy |
Gets or sets the FullName of IAuthorizationPolicy to be used for securing all web service Endpoints.
(Inherited from ISelfHostingService) |
| ServiceHost |
Gets the ServiceHost hosting the web service.
(Inherited from ISelfHostingService) |
| SettingsCategory |
Gets or sets the category name under which the object settings are persisted in the config file.
(Inherited from IPersistSettings) |
| Singleton |
Gets or sets a boolean value that indicates whether the ServiceHost will use the current instance of the web service for processing
requests or base the web service instance creation on InstanceContextMode specified in its ServiceBehaviorAttribute.
(Inherited from ISelfHostingService) |
| Status |
Gets the current status details about object providing status information.
(Inherited from IProvideStatus) |
| TypeName |
Gets or sets the text representation of the IAdapter's TypeName.
(Inherited from IAdapter) |
Methods| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| Initialize |
Initializes the state of the object.
(Inherited from ISupportLifecycle) |
| LoadSettings |
Loads saved settings from the config file.
(Inherited from IPersistSettings) |
| SaveSettings |
Saves settings to the config file.
(Inherited from IPersistSettings) |
Events| Name | Description | |
|---|---|---|
 | Disposed |
Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle) |
| ExecutionException |
Occurs when the IAdapter encounters an Exception during execution.
(Inherited from IAdapter) |
| ServiceHostCreated |
Occurs when the ServiceHost has been created with the specified Endpoints.
(Inherited from ISelfHostingService) |
| ServiceHostStarted |
Occurs when the ServiceHost can process requests via all of its endpoints.
(Inherited from ISelfHostingService) |
| ServiceProcessException |
Occurs when an Exception is encountered when processing a request.
(Inherited from ISelfHostingService) |
| StatusUpdate |
Occurs when the IAdapter wants to provide a status update.
(Inherited from IAdapter) |
See Also