ISchedulerJob::MaximumNumberOfSockets property

Retrieves or sets the maximum number of sockets that the scheduler may allocate for the job.

This property is read/write.

Syntax


HRESULT put_MaximumNumberOfSockets(
  [in]  long maxSockets
);

HRESULT get_MaximumNumberOfSockets(
  [out] long *pMaxSockets
);

Property value

The maximum number of sockets.

Error codes

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code. To get a description of the error, access the ISchedulerJob::ErrorMessage property.

Remarks

Set this property if the ISchedulerJob::UnitType job property is JobUnitType_Socket.

If you set this property, you must set the ISchedulerJob::AutoCalculateMax property to VARIANT_FALSE; otherwise, the maximum number of sockets that you specified will be ignored.

The Default job template sets the default value to 1.

This property tells the scheduler that the job requires at most n sockets to run (the scheduler will not allocate more than this number of sockets for the job).

The job can run when its minimum resource requirements are met. The scheduler may allocate up to the maximum specified resource limit for the job. The scheduler will allocate more resources to the job or release resources if the ISchedulerJob::CanGrow or ISchedulerJob::CanShrink properties are set to VARIANT_TRUE; otherwise, the job uses the initial allocation for its lifetime.

The property value cannot:

Requirements

Product

HPC Pack 2008 R2 Client Utilities, HPC Pack 2008 Client Utilities

Type library

Microsoft.Hpc.Scheduler.tlb

See also

ISchedulerJob
ISchedulerJob.MaximumNumberOfCores
ISchedulerJob.MaximumNumberOfNodes
ISchedulerJob.MinimumNumberOfSockets

 

 

Show: