|
Service
|
Represents the time-series framework service host.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.ServiceProcessServiceBase
GSF.TimeSeriesServiceHostBase
SystemMarshalByRefObject
System.ComponentModelComponent
System.ServiceProcessServiceBase
GSF.TimeSeriesServiceHostBase
Namespace: GSF.TimeSeries
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.230-beta
Syntaxpublic class ServiceHostBase : ServiceBase
The ServiceHostBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ServiceHostBase | Creates a new ServiceHostBase. |
| ServiceHostBase(IContainer) | Creates a new ServiceHostBase from specified parameters. |
Properties| Name | Description | |
|---|---|---|
 | ActionAdapters | Gets reference to the ActionAdapterCollection. |
| AllAdapters | Gets reference to the AllAdaptersCollection. |
 | AutoLog | Indicates whether to report Start, Stop, Pause, and Continue commands in the event log. (Inherited from ServiceBase) |
| CanHandlePowerEvent | Gets or sets a value indicating whether the service can handle notifications of computer power status changes. (Inherited from ServiceBase) |
| CanHandleSessionChangeEvent | Gets or sets a value that indicates whether the service can handle session change events received from a Terminal Server session. (Inherited from ServiceBase) |
| CanPauseAndContinue | Gets or sets a value indicating whether the service can be paused and resumed. (Inherited from ServiceBase) |
| CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| CanShutdown | Gets or sets a value indicating whether the service should be notified when the system is shutting down. (Inherited from ServiceBase) |
| CanStop | Gets or sets a value indicating whether the service can be stopped once it has started. (Inherited from ServiceBase) |
| ConfigurationType | Gets the defined system ConfigurationType. |
| ConsoleApplicationName | Gets the related remote console application name. |
| Container | Gets the IContainer that contains the Component. (Inherited from Component) |
| DataSource | Gets the currently loaded system configuration DataSet. |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| EventLog | Gets an event log you can use to write notification of service command calls, such as Start and Stop, to the Application event log. (Inherited from ServiceBase) |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| ExitCode | Gets or sets the exit code for the service. (Inherited from ServiceBase) |
| FilterAdapters | Gets reference to the FilterAdapterCollection. |
| InputAdapters | Gets reference to the InputAdapterCollection. |
| NodeID | Gets the current node ID. |
| NodeIDQueryString | Gets the current node ID formatted for use in a SQL query string based on ConfigurationType. |
| OutputAdapters | Gets reference to the OutputAdapterCollection. |
| RemotingServer | Gets reference to the TcpServer based remoting server. |
| ServiceHandle | Gets the service control handle for the service. (Inherited from ServiceBase) |
| ServiceHelper | Gets access to the ServiceHelper. |
| ServiceName | Gets or sets the short name used to identify the service to the system. (Inherited from ServiceBase) |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) |
Methods| Name | Description | |
|---|---|---|
 | ActionRequestHandler | Generic adapter request handler. |
| AuthenticateRequestHandler | Attempts to authenticate or re-authenticate to network shares. |
| CacheCurrentConfiguration | Caches the current system configuration. |
| ConnectionErrorLogExceptionHandler | Event handler for processing exceptions encountered while writing entries to the connection log file. |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| DisplayResponseMessage | Displays a response message to client requester. |
| DisplayStatusMessage(String, UpdateType) | Displays a broadcast message to all subscribed clients. |
| DisplayStatusMessage(String, UpdateType, Boolean) | Displays a broadcast message to all subscribed clients. |
| DisplayStatusMessage(String, UpdateType, Object) | Displays a broadcast message to all subscribed clients. |
| DisplayStatusMessage(String, UpdateType, Boolean, Object) | Displays a broadcast message to all subscribed clients. |
| Dispose | Releases all resources used by the Component. (Inherited from Component) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the ServiceHostBase object and optionally releases the managed resources.
(Overrides ServiceBaseDispose(Boolean)) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ErrorLogExceptionHandler | Event handler for processing exceptions encountered while writing entries to the error log file. |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetInputMeasurementsRequestHandler | Gets adapter input measurements. |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetOutputMeasurementsRequestHandler | Gets adapter output measurements. |
| GetRequestedAdapter(ClientRequestInfo) | Gets requested IAdapter. |
| GetRequestedAdapter(ClientRequestInfo, IAdapterCollection) | Gets requested IAdapter and its containing IAdapterCollection. |
| GetRequestedCollection | Gets requested IAdapterCollection. |
| GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HealthMonitorProcessHandler | Event handler for scheduled health monitor display. |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| InitializeRequestHandler | Performs initialization or reinitialization of specified adapter or collection. |
| InitializeServiceHelper | Initializes the service helper. |
| InvokeRequestHandler | Invokes specified adapter command. |
| ListCommandsRequestHandler | Lists possible commands of specified adapter. |
| ListRequestHandler | Displays status of specified adapter or collection. |
| LogEventRequestHandler | Sends remote entry for logging. |
| LogException | Logs an exception to the service helper ErrorLogger. |
| LogExceptionHandler | Event handler for processing exceptions encountered while writing entries to any log file. |
| ManageCertificateHandler | Manages the certificate used by the service. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| OnContinue |
Handles service continue event.
(Overrides ServiceBaseOnContinue) |
| OnCustomCommand | When implemented in a derived class, OnCustomCommand(Int32) executes when the Service Control Manager (SCM) passes a custom command to the service. Specifies actions to take when a command with the specified parameter value occurs. (Inherited from ServiceBase) |
| OnPause |
Handles service pause event.
(Overrides ServiceBaseOnPause) |
| OnPowerEvent | When implemented in a derived class, executes when the computer's power status has changed. This applies to laptop computers when they go into suspended mode, which is not the same as a system shutdown. (Inherited from ServiceBase) |
| OnSessionChange | Executes when a change event is received from a Terminal Server session. (Inherited from ServiceBase) |
| OnShutdown |
Handles service shut down event.
(Overrides ServiceBaseOnShutdown) |
| OnStart |
Handles service start event.
(Overrides ServiceBaseOnStart(String)) |
| OnStop |
Handles service stop event.
(Overrides ServiceBaseOnStop) |
| PingRequestHandler | Used to ping a device. |
| PropagateDataSource | Handle assignment of data source to Iaon session. |
| RefreshRoutesRequestHandler | Recalculates routing tables. |
| ReloadConfigRequestHandler | Manually reloads system configuration. |
| ReportingProcessHandler | Event handler for scheduled reporting services. |
| RequestAdditionalTime | Requests additional time for a pending operation. (Inherited from ServiceBase) |
| RestartServiceHandler | Attempts to restart the hose service. |
| SendResponse(ClientRequestInfo, Boolean) | Sends an actionable response to client. |
| SendResponse(ClientRequestInfo, Boolean, String, Object) | Sends an actionable response to client with a formatted message. |
| SendResponseWithAttachment | Sends an actionable response to client with a formatted message and attachment. |
| ServiceMainCallback | Registers the command handler and starts the service. (Inherited from ServiceBase) |
| ServiceStartedHandler | Event handler for service started operation. |
| ServiceStartingHandler | Event handler for service starting operations. |
| ServiceStoppingHandler | Event handler for service stopping operation. |
| StartRequestHandler | Starts specified adapter. |
| StatusExportProcessHandler | Event handler for scheduled adapter status export. |
| StatusLogExceptionHandler | Event handler for processing exceptions encountered while writing entries to the status log file. |
| Stop | Stops the executing service. (Inherited from ServiceBase) |
| StopRequestHandler | Stops specified adapter. |
| TemporalSupportRequestHandler | Determines support for temporal processing from existing adapters. |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
| UpdateConfigFileRequestHandler | Updates an option in the configuration file. |
Events| Name | Description | |
|---|---|---|
 | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
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