|
Service
|
Component that provides added functionality to a Windows Service.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
GSF.ServiceProcessServiceHelper
SystemMarshalByRefObject
System.ComponentModelComponent
GSF.ServiceProcessServiceHelper
Namespace: GSF.ServiceProcess
Assembly: GSF.ServiceProcess (in GSF.ServiceProcess.dll) Version: 2.4.230-beta
Syntax[ToolboxBitmapAttribute(typeof(ServiceHelper))] public class ServiceHelper : Component, ISupportLifecycle, IDisposable, ISupportInitialize, IProvideStatus, IPersistSettings
The ServiceHelper type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ServiceHelper | Initializes a new instance of the ServiceHelper class. |
| ServiceHelper(IContainer) | Initializes a new instance of the ServiceHelper class. |
Properties| Name | Description | |
|---|---|---|
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) |
 | ClientRequestHandlers | Gets a list of ClientRequestHandler registered for handling requests from RemoteClients. |
| ClientRequestHistory | Gets a list of ClientRequestInfo for requests made by RemoteClients. |
| ConnectionErrorLogger | Gets the ErrorLogger component used for logging connection related exceptions encountered in the ParentService. |
| Container | Gets the IContainer that contains the Component. (Inherited from Component) |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| Enabled | Gets or sets a boolean value that indicates whether the ServiceHelper is currently enabled. |
| ErrorLogger | Gets the ErrorLogger component used for logging errors encountered in the ParentService. |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| HealthMonitorInterval | Gets or sets the interval, in seconds, over which to sample the performance monitor for health statistics. |
| IsDisposed | Gets a flag that indicates whether the object has been disposed. |
| LogStatusUpdates | Gets or sets a boolean value that indicates whether messages sent using UpdateStatus(UpdateType, String, Object) or UpdateStatus(Guid, UpdateType, String, Object) are to be logged to the StatusLog. |
| MaxStatusUpdatesFrequency | Gets or sets the maximum number of status update messages that can be issued in a second without getting suppressed from being displayed. |
| MaxStatusUpdatesLength | Gets or sets the maximum numbers of characters allowed in update status messages without getting suppressed from being displayed. |
| MonitorServiceHealth | Gets or sets a boolean value that indicates whether the health of the ParentService is to be monitored. |
| Name | Gets the unique identifier of the ServiceHelper. |
| ParentService | Gets or sets the ServiceBase to which the ServiceHelper will provided added functionality. |
| PerformanceMonitor | Gets the PerformanceMonitor object used for monitoring the health of the ParentService. |
| PersistSettings | Gets or sets a boolean value that indicates whether the settings of ServiceHelper are to be saved to the config file. |
| Processes | Gets a list of ServiceProcess defined in the ServiceHelper. |
| ProcessScheduler | Gets the ScheduleManager component used for scheduling defined ServiceProcess. |
| RemoteClients | Gets a list of ClientInfo for remote clients connected to the RemotingServer. |
| RemotingServer | Gets or sets the ServerBase component used for communicating with RemoteClients. |
| RequestHistoryLimit | Gets or sets the maximum number of ClientRequest entries to be maintained in the ClientRequestHistory. |
| SecureRemoteInteractions | Gets or sets a boolean value that indicates whether ServiceHelper will secure remote interactions from ClientHelper. |
| SerializationFormat | Gets or sets a value that indicates the desired message SerializationFormat for interaction with ClientHelper. |
| ServiceComponents | Gets a list of components that implement the ISupportLifecycle interface used by the ParentService. |
| SettingsCategory | Gets or sets the category under which the settings of ServiceHelper are to be saved to the config file if the PersistSettings property is set to true. |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) |
| Status | Gets the descriptive status of the ServiceHelper. |
| StatusLog | Gets the LogFile component used for logging status messages to a text file. |
| SupportFileManagementCommands | Gets or sets boolean value that indicates whether the ServiceHelper will have support for file-management commands. |
| SupportSystemCommands | Gets or sets a boolean value that indicates whether ServiceHelper commands will have support for system-level access (-system switch). |
| SupportTelnetSessions | Gets or sets a boolean value that indicates whether the ServiceHelper will have support for remote telnet-like sessions. |
Methods| Name | Description | |
|---|---|---|
| AddProcess(ActionString, Object, String) | Adds a new ServiceProcess to the ServiceHelper. |
| AddProcess(ActionString, Object, String, Object) | Adds a new ServiceProcess to the ServiceHelper. |
| AddScheduledProcess(ActionString, Object, String, String) | Adds a new ServiceProcess to the ServiceHelper that executes on a schedule. |
| AddScheduledProcess(ActionString, Object, String, Object, String) | Adds a new ServiceProcess to the ServiceHelper that executes on a schedule. |
| BeginInit | Performs necessary operations before the ServiceHelper properties are initialized. |
| 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) |
| DisconnectClient | Disconnects the client from the service. |
| Dispose | Releases all resources used by the Component. (Inherited from Component) |
 | Dispose(Boolean) |
Releases the unmanaged resources used by the ServiceHelper object and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean)) |
| EndInit | Performs necessary operations after the ServiceHelper properties are initialized. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component) |
| FindClientRequestHandler | Returns the ClientRequestHandler object for the specified handlerCommand. |
| FindConnectedClient | Returns the ClientInfo object for the specified clientID. |
| FindProcess | Returns the ServiceProcess for the specified processName. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| 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) |
| Initialize | Initializes the ServiceHelper. |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| LoadSettings | Loads saved settings of the ServiceHelper from the config file if the PersistSettings property is set to true. |
| LoadSettings(Boolean) | Loads saved settings of the ServiceHelper from the config file if the PersistSettings property is set to true. |
| LogConnectionException | Log exception to ConnectionErrorLogger. |
| LogException | Log exception to ErrorLogger. |
| 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) |
| OnLoggedException | Raises LoggedException event with logged exception. |
| OnPause | To be called from the OnPause method of ParentService. |
| OnProcessStateChanged | Raises the ProcessStateChanged event. |
| OnReceivedClientRequest | Raises the ReceivedClientRequest event. |
| OnResume | To be called from the OnContinue method of ParentService. |
| OnSendingClientResponse | Raises the SendingClientResponse event. |
| OnServicePaused | Raises the ServicePaused event. |
| OnServicePausing | Raises the ServicePausing event. |
| OnServiceResumed | Raises the ServiceResumed event. |
| OnServiceResuming | Raises the ServiceResuming event. |
| OnServiceStarted | Raises the ServiceStarted event. |
| OnServiceStarting | Raises the ServiceStarting event. |
| OnServiceStopped | Raises the ServiceStopped event. |
| OnServiceStopping | Raises the ServiceStopping event. |
| OnShutdown | To be called from the OnShutdown method of ParentService. |
| OnStart | To be called from the OnStart(String) method of ParentService. |
| OnStop | To be called from the OnStop method of ParentService. |
| OnSystemShutdown | Raises the SystemShutdown event. |
| OnUpdatedStatus | Raises the UpdatedStatus event with the updated status message. |
| RemoveProcess | Removes an existing ServiceProcess from the ServiceHelper. |
| RemoveScheduledProcess | Removes an existing ServiceProcess from the ServiceHelper that is scheduled for automatic execution. |
| SaveSettings | Saves settings of the ServiceHelper to the config file if the PersistSettings property is set to true. |
| SaveSettings(Boolean) | Saves settings of the ServiceHelper to the config file if the PersistSettings property is set to true. |
| ScheduleProcess(String, String) | Schedules an existing ServiceProcess for automatic execution. |
| ScheduleProcess(String, String, Boolean) | Schedules an existing ServiceProcess for automatic execution. |
| SendActionableResponse | Sends an actionable response to client along with an optional formatted message and attachment. |
| SendResponse(ServiceResponse) | Sends the specified response to all RemoteClients. |
| SendResponse(Guid, ServiceResponse) | Sends the specified response to the specified client only. |
| SendResponse(Guid, ServiceResponse, Boolean) | Sends the specified response to the specified client only. |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
| UnscheduleProcess | Unschedules an existing ServiceProcess scheduled for automatic execution. |
| UpdateStatus(UpdateType, String, Object) | Provides a status update to all RemoteClients. |
| UpdateStatus(Guid, UpdateType, String, Object) | Provides a status update to the specified client. |
| UpdateStatus(UpdateType, Boolean, String, Object) | Provides a status update to all RemoteClients. |
| UpdateStatus(Guid, UpdateType, Boolean, String, Object) | Provides a status update to the specified client. |
| UpdateStatusAppendLine(UpdateType, String, Object) | Provides a line terminated status update to all RemoteClients. |
| UpdateStatusAppendLine(Guid, UpdateType, String, Object) | Provides a line terminated status update to the specified client. |
Events| Name | Description | |
|---|---|---|
 | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
| LoggedException | Provides notification of when there is an exception logged. |
| ProcessStateChanged | Occurs when the state of a defined ServiceProcess changes. |
| ReceivedClientRequest | Occurs when a request is received from one of the RemoteClients. |
| SendingClientResponse | Occurs when a response is being sent to one or more RemoteClients. |
| ServicePaused | Occurs when the ParentService has paused. |
| ServicePausing | Occurs when the ParentService is pausing. |
| ServiceResumed | Occurs when the ParentService has resumed. |
| ServiceResuming | Occurs when the ParentService is resuming. |
| ServiceStarted | Occurs when the ParentService has started. |
| ServiceStarting | Occurs when the ParentService is starting. |
| ServiceStopped | Occurs when the ParentService has stopped. |
| ServiceStopping | Occurs when the ParentService is stopping. |
| SystemShutdown | Occurs when the system is being shutdown. |
| UpdatedStatus | Provides notification of when status messages were sent to consumer(s). |
Fields| Name | Description | |
|---|---|---|
  | DefaultHealthMonitorInterval | Specifies the default value for the HealthMonitorInterval property. |
| DefaultLogStatusUpdates | Specifies the default value for the LogStatusUpdates property. |
| DefaultMaxStatusUpdatesFrequency | Specifies the default value for the MaxStatusUpdatesFrequency property. |
| DefaultMaxStatusUpdatesLength | Specifies the default value for the MaxStatusUpdatesLength property. |
| DefaultMonitorServiceHealth | Specifies the default value for the MonitorServiceHealth property. |
| DefaultPersistSettings | Specifies the default value for the PersistSettings property. |
| DefaultRequestHistoryLimit | Specifies the default value for the RequestHistoryLimit property. |
| DefaultSecureRemoteInteractions | Specifies the default value for the SecureRemoteInteractions property. |
| DefaultSerializationFormat | Specifies the default value for the SerializationFormat property. |
| DefaultSettingsCategory | Specifies the default value for the SettingsCategory property. |
| DefaultSupportFileManagementCommands | Specifies the default value for the SupportFileManagementCommands property. |
| DefaultSupportSystemCommands | Specifies the default value for the SupportSystemCommands property. |
| DefaultSupportTelnetSessions | Specifies the default value for the SupportTelnetSessions property. |
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