Method | Description | |
---|---|---|
AddProcess ( object[]>.Action |
Adds a new ServiceProcess to the ServiceHelper.
|
|
AddProcess ( object[]>.Action |
Adds a new ServiceProcess to the ServiceHelper.
|
|
AddScheduledProcess ( object[]>.Action |
Adds a new ServiceProcess to the ServiceHelper that executes on a schedule.
|
|
AddScheduledProcess ( object[]>.Action |
Adds a new ServiceProcess to the ServiceHelper that executes on a schedule.
|
|
DisconnectClient ( System.Guid clientID ) : void |
Disconnects the client from the service.
|
|
FindClientRequestHandler ( string handlerCommand ) : GSF.ServiceProcess.ClientRequestHandler |
Returns the ClientRequestHandler object for the specified handlerCommand.
|
|
FindConnectedClient ( System.Guid clientID ) : |
Returns the ClientInfo object for the specified clientID.
|
|
FindProcess ( string processName ) : ServiceProcess |
Returns the ServiceProcess for the specified processName.
|
|
Initialize ( ) : void |
Initializes the ServiceHelper. Initialize() is to be called by user-code directly only if the ServiceHelper object is not consumed through the designer surface of the IDE. |
|
LoadSettings ( ) : void |
Loads saved settings of the ServiceHelper from the config file if the PersistSettings property is set to true.
|
|
LoadSettings ( bool includeServiceComponents ) : void |
Loads saved settings of the ServiceHelper from the config file if the PersistSettings property is set to true.
|
|
LogException ( |
Log exception to ErrorLogger.
|
|
RemoveProcess ( string processName ) : bool |
Removes an existing ServiceProcess from the ServiceHelper.
|
|
RemoveScheduledProcess ( string processName ) : bool |
Removes an existing ServiceProcess from the ServiceHelper that is scheduled for automatic execution.
|
|
SaveSettings ( ) : void |
Saves settings of the ServiceHelper to the config file if the PersistSettings property is set to true.
|
|
SaveSettings ( bool includeServiceComponents ) : void |
Saves settings of the ServiceHelper to the config file if the PersistSettings property is set to true.
|
|
ScheduleProcess ( string processName, string scheduleRule ) : bool |
Schedules an existing ServiceProcess for automatic execution.
|
|
ScheduleProcess ( string processName, string scheduleRule, bool updateExistingSchedule ) : bool |
Schedules an existing ServiceProcess for automatic execution.
|
|
SendActionableResponse ( GSF.ServiceProcess.ClientRequestInfo requestInfo, bool success, object attachment = null, string status = null ) : void |
Sends an actionable response to client along with an optional formatted message and attachment. This method is used to send an actionable client response that can be used for responding to an event after a command has been issued. |
|
SendResponse ( System.Guid client, |
Sends the specified response to the specified client only.
|
|
SendResponse ( System.Guid client, |
Sends the specified response to the specified client only.
|
|
SendResponse ( |
Sends the specified response to all RemoteClients.
|
|
ServiceHelper ( ) : GSF.Annotations |
Initializes a new instance of the ServiceHelper class.
|
|
ServiceHelper ( IContainer container ) : GSF.Annotations |
Initializes a new instance of the ServiceHelper class.
|
|
UnscheduleProcess ( string processName ) : bool |
Unschedules an existing ServiceProcess scheduled for automatic execution.
|
Method | Description | |
---|---|---|
Dispose ( bool disposing ) : void |
Releases the unmanaged resources used by the ServiceHelper object and optionally releases the managed resources.
|
|
OnLoggedException ( |
Raises LoggedException event with logged exception.
|
|
OnProcessStateChanged ( string processName, ServiceProcessState processState ) : void |
Raises the ProcessStateChanged event.
|
|
OnReceivedClientRequest ( |
Raises the ReceivedClientRequest event.
|
|
OnServicePaused ( ) : void |
Raises the ServicePaused event.
|
|
OnServicePausing ( ) : void |
Raises the ServicePausing event.
|
|
OnServiceResumed ( ) : void |
Raises the ServiceResumed event.
|
|
OnServiceResuming ( ) : void |
Raises the ServiceResuming event.
|
|
OnServiceStarted ( ) : void |
Raises the ServiceStarted event.
|
|
OnServiceStarting ( string args ) : void |
Raises the ServiceStarting event.
|
|
OnServiceStopped ( ) : void |
Raises the ServiceStopped event.
|
|
OnServiceStopping ( ) : void |
Raises the ServiceStopping event.
|
|
OnSystemShutdown ( ) : void |
Raises the SystemShutdown event.
|
|
OnUpdatedStatus ( System.Guid clientID, string status, UpdateType type ) : void |
Raises the UpdatedStatus event with the updated status message. This overload combines string.Format and SendStatusMessage for convenience. |
Method | Description | |
---|---|---|
AbortProcess ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
BeginInit ( ) : void | ||
CurtailMessageLength ( string message ) : string | ||
EndInit ( ) : void | ||
ErrorLogger_LoggingException ( object sender, EventArgs |
||
LoadSchedules ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
LogicalThread_ProcessException ( object sender, EventArgs |
||
ManageFiles ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
OnPause ( ) : void | ||
OnResume ( ) : void | ||
OnShutdown ( ) : void | ||
OnStart ( string args ) : void | ||
OnStop ( ) : void | ||
PrioritizeStatusUpdate ( StatusUpdate update ) : void | ||
ProcessStatusUpdates ( ) : void | ||
Process_StateChanged ( object sender, |
||
QueueStatusUpdate ( StatusUpdate update ) : void | ||
ReloadCryptoCache ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ReloadSettings ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
RemoteCommandProcess_ErrorDataReceived ( object sender, |
||
RemoteCommandProcess_OutputDataReceived ( object sender, |
||
RemoteTelnetSession ( GSF.ServiceProcess.ClientRequestInfo requestinfo ) : void | ||
RemotingServer_ClientConnectingException ( object sender, EventArgs |
||
RemotingServer_ClientDisconnected ( object sender, EventArgs |
||
RemotingServer_ReceiveClientDataComplete ( object sender, EventArgs |
||
RescheduleProcess ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ResetHealthMonitor ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
SaveSchedules ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
Scheduler_ScheduleDue ( object sender, EventArgs |
||
SendAuthenticationFailureResponse ( System.Guid clientID ) : void | ||
SendAuthenticationSuccessResponse ( System.Guid clientID ) : void | ||
SendProcessStateChangedResponse ( string processName, ServiceProcessState currentState ) : void | ||
SendServiceStateChangedResponse ( ServiceState currentState ) : void | ||
SendUpdateClientStatusResponse ( System.Guid clientID, UpdateType type, string responseMessage, bool telnetMessage = false ) : void | ||
ShowClients ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowHealthReport ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowProcesses ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowRequestHelp ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowRequestHistory ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowSchedules ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowServiceStatus ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowSettings ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowTime ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowUser ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
ShowVersion ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
StartProcess ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
StatusLog_LogException ( object sender, EventArgs |
||
TransferFile ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
TrySetCurrentThreadPrincipal ( |
||
UnscheduleProcess ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
UpdateClientFilter ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
UpdateSettings ( GSF.ServiceProcess.ClientRequestInfo requestInfo ) : void | ||
UpdateStatus ( System.Guid client, UpdateType type, bool publishToLog, string message ) : void | ||
UpdateStatus ( System.Guid client, UpdateType type, string message ) : void | ||
UpdateStatus ( UpdateType type, bool publishToLog, string message ) : void | ||
UpdateStatus ( UpdateType type, string message ) : void | ||
UpdateStatusAppendLine ( System.Guid client, UpdateType type, string message ) : void | ||
UpdateStatusAppendLine ( UpdateType type, string message ) : void | ||
VerifySecurity ( |
public AddProcess ( object[]>.Action |
||
processExecutionMethod | object[]>.Action | The |
processName | string | Name of the |
return | bool |
public AddProcess ( object[]>.Action |
||
processExecutionMethod | object[]>.Action | The |
processName | string | Name of the |
processArguments | object | Arguments to be passed in to the |
return | bool |
public AddScheduledProcess ( object[]>.Action |
||
processExecutionMethod | object[]>.Action | The |
processName | string | Name of the |
processArguments | object | Arguments to be passed in to the |
processSchedule | string | |
return | bool |
public AddScheduledProcess ( object[]>.Action |
||
processExecutionMethod | object[]>.Action | The |
processName | string | Name of the |
processSchedule | string | |
return | bool |
public DisconnectClient ( System.Guid clientID ) : void | ||
clientID | System.Guid | The ID of the client. |
return | void |
protected Dispose ( bool disposing ) : void | ||
disposing | bool | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
return | void |
public FindClientRequestHandler ( string handlerCommand ) : GSF.ServiceProcess.ClientRequestHandler | ||
handlerCommand | string | Request type whose |
return | GSF.ServiceProcess.ClientRequestHandler |
public FindConnectedClient ( System.Guid clientID ) : |
||
clientID | System.Guid | ID of the client whose |
return |
public FindProcess ( string processName ) : ServiceProcess | ||
processName | string | Name of the |
return | ServiceProcess |
public LoadSettings ( bool includeServiceComponents ) : void | ||
includeServiceComponents | bool | A boolean value that indicates whether the settings of |
return | void |
public LogException ( |
||
ex | Exception to log. | |
return | void |
protected OnLoggedException ( |
||
ex | Logged |
|
return | void |
protected OnProcessStateChanged ( string processName, ServiceProcessState processState ) : void | ||
processName | string | Name of the |
processState | ServiceProcessState | New |
return | void |
protected OnReceivedClientRequest ( |
||
request | The |
|
requestSender | The |
|
return | void |
protected OnServiceStarting ( string args ) : void | ||
args | string | Arguments to be sent to |
return | void |
protected OnUpdatedStatus ( System.Guid clientID, string status, UpdateType type ) : void | ||
clientID | System.Guid | ID of the client receiving the message. |
status | string | Updated status message. |
type | UpdateType | |
return | void |
public RemoveProcess ( string processName ) : bool | ||
processName | string | Name of the |
return | bool |
public RemoveScheduledProcess ( string processName ) : bool | ||
processName | string | Name of the scheduled |
return | bool |
public SaveSettings ( bool includeServiceComponents ) : void | ||
includeServiceComponents | bool | A boolean value that indicates whether the settings of |
return | void |
public ScheduleProcess ( string processName, string scheduleRule ) : bool | ||
processName | string | Name of the |
scheduleRule | string | Rule that defines the execution pattern of the |
return | bool |
public ScheduleProcess ( string processName, string scheduleRule, bool updateExistingSchedule ) : bool | ||
processName | string | Name of the |
scheduleRule | string | Rule that defines the execution pattern of the |
updateExistingSchedule | bool | true if the |
return | bool |
public SendActionableResponse ( GSF.ServiceProcess.ClientRequestInfo requestInfo, bool success, object attachment = null, string status = null ) : void | ||
requestInfo | GSF.ServiceProcess.ClientRequestInfo | |
success | bool | Flag that determines if this response to client request was a success. |
attachment | object | Attachment to send with response. |
status | string | Formatted status message to send with response. |
return | void |
public SendResponse ( System.Guid client, |
||
client | System.Guid | ID of the client to whom the |
response | The |
|
return | void |
public SendResponse ( System.Guid client, |
||
client | System.Guid | ID of the client to whom the |
response | The |
|
async | bool | Flag to determine whether to wait for the send operations to complete. |
return | void |
public SendResponse ( |
||
response | The |
|
return | void |
public ServiceHelper ( IContainer container ) : GSF.Annotations | ||
container | IContainer | |
return | GSF.Annotations |
public UnscheduleProcess ( string processName ) : bool | ||
processName | string | Name of the |
return | bool |