TaskEnvironment Class

Represents the task environment in the system. The task environment provides common methods to run before and after Task is run.

Inheritance Hierarchy

SystemObject
AGI.Parallel.InfrastructureTaskEnvironment
AGI.Parallel.InfrastructureDefaultTaskEnvironment

Namespace: AGI.Parallel.Infrastructure
Assembly: AGI.Parallel.Infrastructure (in AGI.Parallel.Infrastructure.dll) Version: 2.9.0.1601 (2.9.0.1601)

Syntax

Copy

[SerializableAttribute]
public abstract class TaskEnvironment

<SerializableAttribute>
Public MustInherit Class TaskEnvironment

The TaskEnvironment type exposes the following members.

Constructors

	Name	Description
	TaskEnvironment	Initializes a new instance of the TaskEnvironment class.

Top

Properties

	Name	Description
	AdditionalId	Gets or sets the optional additional id of the environment. Environment can be reused if Environment IDs are identical.
	AttachToDebugger	Gets or sets a value indicating whether to automatically attach the host processes to the debugger running the client submission code.
	DebuggerType	Gets or sets the type of the debugger used by the host process to attach itself to Visual Studio.
	HostArchitecture	Gets or sets the desired CPU Architecture of the host that executes the task.
	HostGcMode	Gets or sets the garbage collection of the host environment.
	Id	Gets or sets the id of the environment. Environment can be reused if the environment IDs are identical.
	Name	Gets or sets the display name of the task environment.
	Properties	Gets task environment properties.
	RecycleSettings	Gets or sets the recycling settings that determine when to shutdown the host process on which tasks run.
	RequiredLicense	Gets or sets the required license associated with this environment.
	TasksPerHost	Obsolete. Gets or sets the number of tasks this environment will execute before shutting down.
	TeardownTimeout	Gets or sets the amount of time teardown can run for before it is timed-out in milliseconds.
	ThreadApartmentState	Gets or sets the apartment state of the thread that will be used to set the task environment and execute the tasks. The default is to use STA (i.e. ApartmentState.STA).
	WorkingDirectory	Gets or sets the custom working directory of the task environment.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetProperty(String)	Returns property value by name.
	GetPropertyT(String)	Returns property value by name.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetConfigurationFile	Specifies the .NET configuration file to load into the host application domain during task execution. If you wish to use the current configuration file, pass in [!:System.AppDomainSetup.ConfigurationFile].
	SetConfigurationString	Specifies the .NET configuration as a string to load into the host application domain during task execution.
	SetProperty(String, Object)	Sets property value.
	SetPropertyT(String, T)	Sets property value.
	Setup	Called by Host before Task is executed.
	Teardown	Called by Host after Task is executed.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

You must implement this class so that it can be serialized by the .NET binary serializer. Add the SerializableAttribute attribute to your class and any other fields that this class references.

Examples

Copy

// You must always make the TaskEnvironment class serializable
[Serializable]
public class MyEnvironment : TaskEnvironment
{
    public override void Setup()
    {
        // Put your common setup logic in the Setup method
    }

    public override void Teardown()
    {
        // Put your common teardown logic in the Teardown method
    }
}

Reference

AGI.Parallel.Infrastructure Namespace

Other Resources

Key concepts

Optimize task setup time with task environment