Service Class

[This is preliminary documentation and is subject to change.]

A base class for web service that can send and receive data over REST (Representational State Transfer) interface.

Declaration Syntax

Visual Basic

Visual C++

public class Service : IService, ISupportLifecycle, 
	IDisposable, IPersistSettings

Public Class Service _
	Implements IService, ISupportLifecycle, IDisposable, IPersistSettings

public ref class Service : IService, 
	ISupportLifecycle, IDisposable, IPersistSettings

Members

Icon	Member	Description
	Service()()()	Initializes a new instance of the web service.
	Archive	Gets or sets the IArchive used by the web service for its data.
	CanRead	Gets a boolean value that indicates whether the web service can read Archive data and send it.
	CanWrite	Gets a boolean value that indicates whether the web service can receive data and write it to Archive.
	Dispose()()()	Releases all the resources used by the web service.
	Dispose(Boolean)	Releases the unmanaged resources used by the web service and optionally releases the managed resources.
	Enabled	Gets or sets a boolean value that indicates whether the web service is currently enabled.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize()()()	Releases the unmanaged resources before the web service is reclaimed by GC. (Overrides Object.Finalize()()().)
	GetHashCode()()()	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType()()()	Gets the Type of the current instance. (Inherited from Object.)
	Initialize()()()	Initializes the web service.
	LoadSettings()()()	Loads saved web service settings from the config file if the PersistSettings property is set to true.
	MemberwiseClone()()()	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnServiceHostCreated()()()	Raises the ServiceHostCreated event.
	OnServiceHostStarted()()()	Raises the ServiceHostStarted event.
	OnServiceProcessError(Exception)	Raises the ServiceProcessError event.
	PersistSettings	Gets or sets a boolean value that indicates whether the web service settings are to be saved to the config file.
	SaveSettings()()()	Saves web service settings to the config file if the PersistSettings property is set to true.
	ServiceContract	Gets or sets the contract interface implemented by the web service.
	ServiceDataFlow	Gets or sets the DataFlowDirection of the web service.
	ServiceHost	Gets the WebServiceHost hosting the web service.
	ServiceHostCreated	Occurs when the ServiceHost has been created for the specified ServiceUri.
	ServiceHostStarted	Occurs when the ServiceHost has can process requests via all of its endpoints.
	ServiceProcessError	Occurs when an Exception is encountered when processing a request.
	ServiceUri	Gets or sets the URI where the web service is to be hosted.
	SettingsCategory	Gets or sets the category under which the web service settings are to be saved to the config file if the PersistSettings property is set to true.
	ToString()()()	Returns a String that represents the current Object. (Inherited from Object.)

Inheritance Hierarchy

Object
	Service
		MetadataService
		TimeSeriesDataService

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.0.0

All Members	Constructors	Methods	Properties	Events
Public Protected		Instance Static		Declared Inherited