Click or drag to resize

ServiceHelper Methods

The ServiceHelper type exposes the following members.

Methods
  Name Description
Public method AddProcess(ActionString, Object, String) Adds a new ServiceProcess to the ServiceHelper.
Public method AddProcess(ActionString, Object, String, Object) Adds a new ServiceProcess to the ServiceHelper.
Public method AddScheduledProcess(ActionString, Object, String, String) Adds a new ServiceProcess to the ServiceHelper that executes on a schedule.
Public method AddScheduledProcess(ActionString, Object, String, Object, String) Adds a new ServiceProcess to the ServiceHelper that executes on a schedule.
Public method BeginInit Performs necessary operations before the ServiceHelper properties are initialized.
Public method 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)
Public method DisconnectClient Disconnects the client from the service.
Public method Dispose Releases all resources used by the Component.
(Inherited from Component)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the ServiceHelper object and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean))
Public method EndInit Performs necessary operations after the ServiceHelper properties are initialized.
Public method Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component)
Public method FindClientRequestHandler Returns the ClientRequestHandler object for the specified handlerCommand.
Public method FindConnectedClient Returns the ClientInfo object for the specified clientID.
Public method FindProcess Returns the ServiceProcess for the specified processName.
Public method GetHashCode Serves as the default hash function.
(Inherited from Object)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component)
Public method GetType Gets the Type of the current instance.
(Inherited from Object)
Public method Initialize Initializes the ServiceHelper.
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public method LoadSettings Loads saved settings of the ServiceHelper from the config file if the PersistSettings property is set to true.
Public method LoadSettings(Boolean) Loads saved settings of the ServiceHelper from the config file if the PersistSettings property is set to true.
Public method LogConnectionException Log exception to ConnectionErrorLogger.
Public method LogException Log exception to ErrorLogger.
Protected method MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Protected method OnLoggedException Raises LoggedException event with logged exception.
Public method OnPause To be called from the OnPause method of ParentService.
Protected method OnProcessStateChanged Raises the ProcessStateChanged event.
Protected method OnReceivedClientRequest Raises the ReceivedClientRequest event.
Public method OnResume To be called from the OnContinue method of ParentService.
Protected method OnSendingClientResponse Raises the SendingClientResponse event.
Protected method OnServicePaused Raises the ServicePaused event.
Protected method OnServicePausing Raises the ServicePausing event.
Protected method OnServiceResumed Raises the ServiceResumed event.
Protected method OnServiceResuming Raises the ServiceResuming event.
Protected method OnServiceStarted Raises the ServiceStarted event.
Protected method OnServiceStarting Raises the ServiceStarting event.
Protected method OnServiceStopped Raises the ServiceStopped event.
Protected method OnServiceStopping Raises the ServiceStopping event.
Public method OnShutdown To be called from the OnShutdown method of ParentService.
Public method OnStart To be called from the OnStart(String) method of ParentService.
Public method OnStop To be called from the OnStop method of ParentService.
Protected method OnSystemShutdown Raises the SystemShutdown event.
Protected method OnUpdatedStatus Raises the UpdatedStatus event with the updated status message.
Public method RemoveProcess Removes an existing ServiceProcess from the ServiceHelper.
Public method RemoveScheduledProcess Removes an existing ServiceProcess from the ServiceHelper that is scheduled for automatic execution.
Public method SaveSettings Saves settings of the ServiceHelper to the config file if the PersistSettings property is set to true.
Public method SaveSettings(Boolean) Saves settings of the ServiceHelper to the config file if the PersistSettings property is set to true.
Public method ScheduleProcess(String, String) Schedules an existing ServiceProcess for automatic execution.
Public method ScheduleProcess(String, String, Boolean) Schedules an existing ServiceProcess for automatic execution.
Public method SendActionableResponse Sends an actionable response to client along with an optional formatted message and attachment.
Public method SendResponse(ServiceResponse) Sends the specified response to all RemoteClients.
Public method SendResponse(Guid, ServiceResponse) Sends the specified response to the specified client only.
Public method SendResponse(Guid, ServiceResponse, Boolean) Sends the specified response to the specified client only.
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)
Public method UnscheduleProcess Unschedules an existing ServiceProcess scheduled for automatic execution.
Public method UpdateStatus(UpdateType, String, Object) Provides a status update to all RemoteClients.
Public method UpdateStatus(Guid, UpdateType, String, Object) Provides a status update to the specified client.
Public method UpdateStatus(UpdateType, Boolean, String, Object) Provides a status update to all RemoteClients.
Public method UpdateStatus(Guid, UpdateType, Boolean, String, Object) Provides a status update to the specified client.
Public method UpdateStatusAppendLine(UpdateType, String, Object) Provides a line terminated status update to all RemoteClients.
Public method UpdateStatusAppendLine(Guid, UpdateType, String, Object) Provides a line terminated status update to the specified client.
Top
Extension Methods
  Name Description
Public Extension Method GetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension Method GetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also