parallel.Worker
Access parallel worker information
Constructors
getCurrentWorkerin the workspace of the MATLAB worker.In the client workspace, a
parallel.Workerobject is available from:The
Workersproperty of aparallel.Poolobject. (since R2025a)The
Workerproperty of aparallel.Taskobject.
Container Hierarchy
Parent |
|
Children | none |
Description
A parallel.Worker object provides access to the MATLAB worker session that
executes a task as part of a job. The job can be an interactive parallel pool job or a
batch job.
Types
| Worker Type | Description |
|---|---|
parallel.cluster.MJSWorker | MATLAB® worker on MATLAB Job Scheduler cluster |
parallel.cluster.CJSWorker | MATLAB worker on CJS cluster |
parallel.ThreadWorker | MATLAB thread worker (since R2025a) |
Methods
There are no methods for a parallel.Worker object other than generic methods
for any objects in the workspace, such as delete, etc.
Properties
MATLAB Job Scheduler Worker
The following table describes the properties of a MATLAB Job Scheduler worker.
| Property | Description |
|---|---|
AllHostAddresses | IP addresses of worker host |
ComputerType | Type of computer on which the worker ran; the value of the
MATLAB function computer executed on the
worker |
Name | Name of worker, set when worker session started |
Parent | MATLAB Job Scheduler cluster to which this worker belongs |
CJS Worker
The following table describes the properties of an CJS worker.
| Property | Description |
|---|---|
ComputerType | Type of computer on which the worker ran; the value of the MATLAB function computer executed on the worker |
Host | Host name where the worker executed the task |
ProcessId | Process identifier for the worker |
Thread Worker
The following table describes the properties of a thread worker.
| Property | Description |
|---|---|
ComputerType | Type of computer on which the worker ran; the value of the
MATLAB function computer executed on the
worker |
Host | Host name where the worker executed the task |
Help
To get further help on the types of parallel.Worker objects, including a list
of links to help for its properties, type:
help parallel.cluster.MJSWorker help parallel.cluster.CJSWorker help parallel.ThreadWorker
See Also
Version History
Introduced in R2012a