Microsoft.Hpc.Scheduler Namespace
This namespace defines the interfaces and enumerations used to submit and monitor jobs in a Microsoft HPC Server.
The HPC Pack software development kit (SDK) contains the assemblies required to build job submission and monitoring applications. To run an application that uses this API, the computer must have the HPC Pack Client Utilities installed.
You should not use the classes contained in this namespace. Instead, you should use the interfaces. Using the interfaces will ensure that you will be using the latest implementation when updates occur.
The Microsoft.Hpc.Scheduler namespace is used to schedule jobs on Microsoft HPC Server 2008 and later. You cannot use this namespace to manage jobs on Microsoft Compute Cluster Server 2003 (CCS), instead you must use the interfaces defined in the Microsoft.ComputeCluster namespace. Applications written for CCS will work on HPC Server 2008.
The primary interface that you use in the Microsoft.Hpc.Scheduler namespace is the IScheduler interface. To get this interface, use the new keyword to instantiate a Scheduler class object as shown in the following example.
IScheduler scheduler = new Scheduler();
Many of the types defined in this namespace use the types defined in the Microsoft.Hpc.Scheduler.Properties namespace.
If you are writing client applications based on the service-oriented architecture (SOA), you will use the Microsoft.Hpc.Scheduler.Session namespace.
For examples that use the types defined in this namespace, see Using HPC.
| Class | Description |
|---|---|
| CommandInfo | Defines property values used by the command. |
| CommandOutputEventArg | Defines the arguments that are passed to your event handler when the command generates a line of output on a node in the cluster. |
| CommandRawOutputEventArg | Defines the arguments that are passed to your event handler when the command generates output on a node in the cluster. The output is passed as a byte blob. |
| CommandTaskStateEventArg | Defines the arguments that are passed to your event handler when the state of the command changes. |
| FilterCollection | Defines a collection of filter property objects used to filter the results when retrieving jobs, task, and nodes. |
| IntCollection | Defines a collection of integer values. Typically, the collection contains job or node identifiers. |
| JobStateEventArg | Defines the arguments that are passed to your event handler when the state of the job changes. |
| JobTemplateInfo | Provides information about a job template, including the identifier, name, description, and security descriptor for the job template. Also provides dates and times for when the job template was created and last changed. |
| NameValue | Represents a name/value pair. |
| NameValueCollection | Represents a collection of name/value pairs. |
| PropertyIdCollection | Defines a collection of property identifiers. |
| RemoteCommand | Defines a command to run on one or more nodes in the cluster. |
| Scheduler | Defines the methods used to schedule and manage the jobs and tasks in a compute cluster. |
| SchedulerCollection | Defines a generic collection of objects that the scheduler returns. |
| SchedulerCore | Provides information about a core on a node such as its state and the task currently running on it. |
| SchedulerCounters | Defines counter information for the cluster. |
| SchedulerJob | Manages the tasks and resources that are associated with a job. |
| SchedulerJobCounters | Defines the counter values related to the status of tasks in the job (for example, the number of tasks that have finished running). |
| SchedulerNode | Contains information about a compute node. |
| SchedulerNodeCounters | Contains counter data information for the node. |
| SchedulerObjectBase | The abstract class from which the HPC objects inherit. |
| SchedulerTask | Defines a task. |
| SchedulerTaskCounters | Contains counter data for the tasks that are running in the cluster. |
| ServerVersion | Contains the file version information for the HPC server assembly. |
| SortCollection | Defines a collection of sort property objects used to sort the results when retrieving jobs, task, and nodes. |
| StringCollection | Defines a collection of string values. |
| TaskStateEventArg | Defines the arguments that are passed to your event handler when the state of a task in the job changes. |
| Interface | Description |
|---|---|
| ICommandInfo | Defines property values used by the command. |
| ICommandOutputEventArg | Defines the arguments that are passed to your event handler when the command generates a line of output on a node in the cluster. |
| ICommandRawOutputEventArg | Defines the arguments that are passed to your event handler when the command generates output on a node in the cluster. The output is passed as a byte blob. |
| ICommandTaskStateEventArg | Defines the arguments that are passed to your event handler when the state of the command changes. |
| IConnectionEventArg | Defines the parameters that are passed to the ReconnectHandler event handler when an application connects to, disconnects from, or reconnects to the HPC Job Scheduler Service or the channel that delivers events from the HPC Job Scheduler Service that relate to changes to the states of jobs, tasks, and nodes. |
| IFilterCollection | Defines a collection of filter property objects used to filter the results when retrieving jobs, task, and nodes. |
| IIntCollection | Defines a collection of integer values. Typically, the collection contains job or node identifiers. |
| IJobStateEventArg | Defines the arguments that are passed to your event handler when the state of the job changes. |
| INameValue | Represents a name/value pair. |
| INameValueCollection | Represents a collection of name/value pairs. |
| INodeReachableEventArg | Defines the parameters that are passed to the NodeReachableHandler event handler when the HPC Node Manager Service on a node becomes reachable or unreachable. |
| INodeStateEventArg | Defines the parameters that are passed to the Microsoft.Hpc.Scheduler.NodeStateHandler event handler when the state of a node changes. |
| IPropertyIdCollection | Defines a collection of property identifiers. |
| IRemoteCommand | Defines a command to execute on one or more nodes in the cluster. |
| IRemoteCommandEvents | Defines the interface that COM applications implement to handle events raised by the IRemoteCommand object. |
| IScheduler | Defines the methods used to schedule and manage the jobs and tasks in a compute cluster. |
| ISchedulerCollection | Defines a generic collection of objects that the scheduler returns. |
| ISchedulerCore | Provides information about a core on a node such as its state and the task currently running on it. |
| ISchedulerCounters | Contains counter information for the cluster. |
| ISchedulerJob | Manages the tasks and resources that are associated with a job. |
| ISchedulerJobCounters | Defines the counter values related to the status of tasks in the job (for example, the number of tasks that have finished running). |
| ISchedulerJobEvents | Defines the interface that COM applications implement to handle events raised by the ISchedulerJob object. |
| ISchedulerNode | Contains information about a compute node. |
| ISchedulerNodeCounters | Contains counter data information for the node. |
| ISchedulerNodeEvents | Defines the interface that COM applications implement to handle events that an ISchedulerNode object raises. |
| ISchedulerNodeReachableEvents | Defines the interface that COM applications implement to handle the events that an ISchedulerNode object raises when the HPC Node Manager Service on a node become reachable or unreachable. |
| ISchedulerPool | Contains information about a pool. |
| ISchedulerRowEnumerator | Contains the methods used to retrieve rows from the enumerator. |
| ISchedulerRowSet | Defines a rowset object that you can use to retrieve data from the rowset. |
| ISchedulerTask | Defines a task. |
| ISchedulerTaskCounters | Contains counter data for the tasks that are running in the cluster. |
| IServerVersion | Contains the file version information for the HPC server assembly. |
| ISortCollection | Defines a collection of sort property objects used to sort the results when retrieving jobs, task, and nodes. |
| IStringCollection | Defines a collection of string values. |
| ITaskStateEventArg | Defines the arguments that are passed to your event handler when the state of a task in the job changes. |
| Delegate | Description |
|---|---|
| CommandOutputHandler | Defines the delegate to implement when you subscribe to the IRemoteCommand.OnCommandOutput event. |
| CommandRawOutputHandler | Defines the delegate to implement when you subscribe to the IRemoteCommand.OnCommandRawOutput event. |
| CommandTaskStateHandler | Defines the delegate to implement when you subscribe to the IRemoteCommand.OnCommandTaskState event. |
| JobStateHandler | Defines the delegate to implement when you subscribe to the ISchedulerJob.OnJobState event. |
| NodeReachableHandler | Defines the delegate that your application implements when you subscribe to the OnNodeReachable event. |
| NodeStateHandler | Defines the delegate that your application implements when you subscribe to the OnNodeState event. |
| ReconnectHandler | Defines the delegate that your application implements when you subscribe to the OnSchedulerReconnect event. |
| TaskStateHandler | Defines the delegate to implement when you subscribe to the ISchedulerJob.OnTaskState event. |
| Enumeration | Description |
|---|---|
| CommandOutputType | Defines the source of the output. |
| ConnectionEventCode | Defines constants that indicate whether an application connected to, disconnected from, or reconnected to the HPC Job Scheduler Service or to the channel that delivers events from the HPC Job Scheduler Service that relate to changes to the states and properties of jobs, tasks, and nodes. |
| PropId | Defines identifiers that uniquely identify job, task, and node properties. Use these property identifiers when specifying a filter or sort property. |
| SchedulerCoreState | Defines the state of a core on a node in the cluster. |
Build Date:
