Click or drag to resize
Grid Solutions Framework

ProcessLauncher Class

Represents an adapter that will launch a configured executable process.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersFacileActionAdapterBase
      FileAdaptersProcessLauncher

Namespace: FileAdapters
Assembly: FileAdapters (in FileAdapters.dll) Version: 2.4.207-beta
Syntax
public class ProcessLauncher : FacileActionAdapterBase
View Source

The ProcessLauncher type exposes the following members.

Constructors
 NameDescription
Public methodProcessLauncher Creates a new instance of the ProcessLauncher class.
Top
Properties
 NameDescription
Public propertyArguments Gets or sets any command line arguments to use when launching the process.
Public propertyAutoStart Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase)
Public propertyChildProcessQueryTimeout Gets or sets the maximum processing time allowed, in milliseconds, for querying for available associated child processes.
Public propertyChildProcessTarget Gets or sets the name of the child process to target for additional monitoring and termination when adapter is disposed.
Public propertyConnectionInfo Gets connection info for adapter, if any.
(Inherited from AdapterBase)
Public propertyConnectionString Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase)
Public propertyCreateNoWindow Gets or sets flag that determines if a new window should be created when launching the process.
Public propertyDataSource Gets or sets DataSet based data source available to this AdapterBase.
(Inherited from AdapterBase)
Public propertyDomain Gets or sets the user domain to use when creating an authentication context before launching the process.
Public propertyEnabled Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase)
Public propertyEnvironmentalVariables Gets or sets any needed environmental variables that should be set or updated before launching the process.
Public propertyErrorDialog Gets or sets flag that determines if an error dialog should be displayed if the process cannot be launched.
Public propertyFallBackOnLocalClock Gets or sets flag that determines whether to fall back on local clock time as real time when time is unreasonable.
(Inherited from FacileActionAdapterBase)
Public propertyFileName Gets or sets the path and filename of executable to launch as a new process.
Public propertyForceKillOnDispose Gets or sets flag that determines if launched process should be forcibly terminated when adapter is disposed.
Public propertyFramesPerSecond Property hidden - not used by ProcessLauncher.
Public propertyID Gets or sets numeric ID associated with this AdapterBase.
(Inherited from AdapterBase)
Public propertyInitialInputFileName Gets or sets filename that contains text to use as standard input into process after it has been launched.
Public propertyInitialInputProcessingDelay Gets or sets the processing delay, in milliseconds, before text defined in the InitialInputFileName is sent to the launched process.
Public propertyInitializationTimeout Gets or sets maximum time system will wait during Start for initialization.
(Inherited from AdapterBase)
Public propertyInitialized Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from AdapterBase)
Public propertyInputMeasurementKeys Property hidden - not used by ProcessLauncher.
Public propertyInputSourceIDs Gets or sets Source values used to filter input measurement keys.
(Inherited from FacileActionAdapterBase)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase)
Public propertyLagTime Property hidden - not used by ProcessLauncher.
Public propertyLatestMeasurements Gets reference to the collection of absolute latest received measurement values.
(Inherited from FacileActionAdapterBase)
Public propertyLeadTime Property hidden - not used by ProcessLauncher.
Public propertyLoadUserProfile Gets or sets flag that determines if Windows user profile should be loaded from the registry before launching the process.
Protected propertyLog Log messages generated by an adapter.
(Inherited from AdapterBase)
Public propertyLogMessageLevelExpression Gets or sets regular expression used to find log message level when redirected output is processed as formatted log messages.
Public propertyLogMessageLevelMappings Gets or sets log level mappings to use when redirected output is processed as formatted log messages.
Public propertyLogMessageTextExpression Gets or sets regular expression used to find log message text when redirected output is processed as formatted log messages.
Public propertyMeasurementReportingInterval Gets or sets the measurement reporting interval.
(Inherited from AdapterBase)
Public propertyName Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase)
Public propertyOutputMeasurements Property hidden - not used by ProcessLauncher.
Public propertyOutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from FacileActionAdapterBase)
Public propertyPassword Gets or sets the user password to use when creating an authentication context before launching the process.
Public propertyProcessedMeasurements Gets the total number of measurements handled thus far by the AdapterBase.
(Inherited from AdapterBase)
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from AdapterBase)
Public propertyProcessOutputAsLogMessages Gets or sets flag that determines if redirected output should be attempted to be parsed as formatted log messages, e.g.: lvl=info msg="log message".
Public propertyRealTime Gets the most accurate time value that is available. If UseLocalClockAsRealTime = true, then this function will return UtcNow. Otherwise, this function will return the timestamp of the most recent measurement.
(Inherited from FacileActionAdapterBase)
Public propertyRedirectErrorToHostEnvironment Gets or sets flag that determines if process standard error output should be redirected to the hosting environment.
Public propertyRedirectOutputToHostEnvironment Gets or sets flag that determines if process standard output should be redirected to the hosting environment.
Public propertyRequestedInputMeasurementKeys Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from FacileActionAdapterBase)
Public propertyRequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from FacileActionAdapterBase)
Public propertyRespectInputDemands Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
(Inherited from FacileActionAdapterBase)
Public propertyRespectOutputDemands Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
(Inherited from FacileActionAdapterBase)
Public propertyRunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase)
Public propertySettings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase)
Public propertyShowChildProcesses Gets or sets flag that determines if child processes should be shown during initialization for configuration purposes.
Public propertyStartTime Gets the UTC time this AdapterBase was started.
(Inherited from AdapterBase)
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertyStatus Returns the detailed status of the data input source.
(Overrides FacileActionAdapterBaseStatus)
Public propertyStopTime Gets the UTC time this AdapterBase was stopped.
(Inherited from AdapterBase)
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter supports temporal processing.
(Overrides AdapterBaseSupportsTemporalProcessing)
Public propertyTrackLatestMeasurements Gets or sets flag to start tracking the absolute latest received measurement values.
(Inherited from FacileActionAdapterBase)
Public propertyTrackProcessStatistics Gets or sets flag that determines if statistics should be tracked for launched process.
Public propertyUseLocalClockAsRealTime Gets or sets flag that determines whether or not to use the local clock time as real time.
(Inherited from FacileActionAdapterBase)
Public propertyUserName Gets or sets the user name to use when creating an authentication context before launching the process.
Public propertyUtilizationUpdateInterval Gets or sets the interval over which to calculate lunched process utilization.
Public propertyWindowStyle Gets or sets window style to use when launching the process if creating a window.
Public propertyWorkingDirectory Gets or sets working directory to use when launching the process.
Top
Methods
 NameDescription
Public methodDispose Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the ProcessLauncher object and optionally releases the managed resources.
(Overrides AdapterBaseDispose(Boolean))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase)
Public methodGetHashCode Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase)
Public methodGetShortStatus Gets a short one-line status of this AdapterBase.
(Overrides AdapterBaseGetShortStatus(Int32))
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodIncrementProcessedMeasurements Safely increments the total processed measurements.
(Inherited from AdapterBase)
Public methodInitialize Initializes ProcessLauncher.
(Overrides FacileActionAdapterBaseInitialize)
Public methodInput Sends specified value as input to launched process, new line will be automatically appended to text.
Public methodKill Stops the launched process and and associated child processes.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterBase)
Protected methodOnDiscardingMeasurements Raises the DiscardingMeasurements event.
(Inherited from FacileActionAdapterBase)
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase)
Protected methodOnNewMeasurements Raises the NewMeasurements event.
(Inherited from FacileActionAdapterBase)
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase)
Protected methodOnProcessException(Exception)Obsolete.
Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnProcessException(MessageLevel, Exception, String, MessageFlags) Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(String)Obsolete.
Raises the StatusMessage event.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(String, Object)Obsolete.
Raises the StatusMessage event with a formatted status message.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterBase)
Protected methodOnUnpublishedSamples Raises the UnpublishedSamples event.
(Inherited from FacileActionAdapterBase)
Public methodQueueMeasurementForProcessing Queues a single measurement for processing.
(Inherited from FacileActionAdapterBase)
Public methodQueueMeasurementsForProcessing Queues a collection of measurements for processing.
(Inherited from FacileActionAdapterBase)
Public methodRefresh Clears any cached information associated with the launched process.
Public methodSetInitializedState Manually sets the initialized state of the AdapterBase.
(Inherited from AdapterBase)
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter.
(Inherited from AdapterBase)
Public methodStart Starts the AdapterBase or restarts it if it is already running.
(Inherited from AdapterBase)
Public methodStop Stops the AdapterBase.
(Inherited from AdapterBase)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase)
Public eventDiscardingMeasurements This event is raised if there are any measurements being discarded during the sorting process.
(Inherited from FacileActionAdapterBase)
Public eventDisposed Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase)
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase)
Public eventNewMeasurements Provides new measurements from action adapter.
(Inherited from FacileActionAdapterBase)
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from AdapterBase)
Public eventProcessException Event is raised when there is an exception encountered while processing.
(Inherited from AdapterBase)
Public eventStatusMessage Provides status messages to consumer.
(Inherited from AdapterBase)
Public eventUnpublishedSamples This event is raised by derived class, if needed, to track current number of unpublished seconds of data in the queue.
(Inherited from FacileActionAdapterBase)
Top
Fields
 NameDescription
Public fieldStatic memberDefaultArguments Default value for the Arguments property.
Public fieldStatic memberDefaultChildProcessQueryTimeout Default value for the ChildProcessQueryTimeout property.
Public fieldStatic memberDefaultChildProcessTarget Default value for the ChildProcessTarget property.
Public fieldStatic memberDefaultCreateNoWindow Default value for the CreateNoWindow property.
Public fieldStatic memberDefaultDomain Default value for the Domain property.
Public fieldStatic memberDefaultEnvironmentalVariables Default value for the EnvironmentalVariables property.
Public fieldStatic memberDefaultErrorDialog Default value for the ErrorDialog property.
Public fieldStatic memberDefaultForceKillOnDispose Default value for the ForceKillOnDispose property.
Public fieldStatic memberDefaultInitialInputFileName Default value for the InitialInputFileName property.
Public fieldStatic memberDefaultInitialInputProcessingDelay Default value for the InitialInputProcessingDelay property.
Public fieldStatic memberDefaultLoadUserProfile Default value for the LoadUserProfile property.
Public fieldStatic memberDefaultLogMessageLevelExpression Default value for the LogMessageLevelExpression property.
Public fieldStatic memberDefaultLogMessageLevelMappings Default value for the LogMessageLevelMappings property.
Public fieldStatic memberDefaultLogMessageTextExpression Default value for the LogMessageTextExpression property.
Public fieldStatic memberDefaultPassword Default value for the Password property.
Public fieldStatic memberDefaultProcessOutputAsLogMessages Default value for the ProcessOutputAsLogMessages property.
Public fieldStatic memberDefaultRedirectErrorToHostEnvironment Default value for the RedirectErrorToHostEnvironment property.
Public fieldStatic memberDefaultRedirectOutputToHostEnvironment Default value for the RedirectOutputToHostEnvironment property.
Public fieldStatic memberDefaultShowChildProcesses Default value for the ShowChildProcesses property.
Public fieldStatic memberDefaultSupportsTemporalProcessing Default value for the SupportsTemporalProcessing property.
Public fieldStatic memberDefaultTrackProcessStatistics Default value for the TrackProcessStatistics property.
Public fieldStatic memberDefaultUserName Default value for the UserName property.
Public fieldStatic memberDefaultWindowStyle Default value for the WindowStyle property.
Public fieldStatic memberDefaultWorkingDirectory Default value for the WorkingDirectory property.
Top
Remarks
Unless credentials are provided to create an authentication context, rights of any launched executable will be limited to those available to time-series host.
See Also