prodserver.addon.FevalFuture

R2026b

Function scheduled to run on MATLAB Production Server

Since R2026b

Description

An FevalFuture object represents a function that you have scheduled to run on MATLAB^® Production Server™.

Creation

Create an FevalFuture object using the prodserver.addon.asyncfeval function.

Properties

CreateDateTime — Date and time when object was created

Read-only: datetime scalar

This property is read-only.

Date and time when the FevalFuture object was created, returned as a datetime scalar.

DeleteDateTime — Time at which object was deleted from the server

Read-only: datetime scalar

This property is read-only.

Date and time at which the FevalFuture object was deleted from the server, returned as a datetime scalar.

Error — Error information

Read-only: scalar or cell array of MException objects

This property is read-only.

Error information, returned as a scalar or cell array of MException objects. If the FevalFuture object completes with no error, this property is empty.

FinishDateTime — Date and time when function finished

Read-only: datetime scalar

This property is read-only.

Date and time when the function finished, returned as a datetime scalar.

The FevalFuture object finishes running when MATLAB finishes running the function associated with it.

If the function associated with the FevalFuture object is not finished running, this property is an empty datetime array.

Function — Function associated with FevalFuture

Read-only: string scalar

This property is read-only.

Function associated with the FevalFuture object, returned as a string scalar.

host — Host name of server

character vector | string scalar

Host name of the MATLAB Production Server instance hosting the deployable archive that created the FevalFuture object, returned as a string scalar or character vector.

Example: "144.213.5.7"

ID — Identifier

Read-only: integer scalar

This property is read-only.

Identifier, returned as an integer scalar.

Data Types: double

InputArguments — Input arguments for function

Read-only: cell array

This property is read-only.

Input arguments for the function, returned as a cell array.

When the scheduled function specified by the Function property runs, it runs as fcn(X{:}), where X is the cell array of input arguments specified by this property.

Example: {[1]}

Example: {[1,2], "string data", 13.2}

NumOutputArguments — Number of arguments requested from the function

Read-only: integer scalar

This property is read-only.

Number of arguments requested from the function, returned as an integer scalar.

The function specified by the Function property must return at least as many arguments as returned by this property.

Data Types: double

OnServerDuration — Duration of function on server

Read-only: duration scalar

This property is read-only.

Duration of the function ran on the server, returned as a duration scalar.

The duration is calculated by subtracting CreateDateTime from now or DeleteDateTime.

OutputArguments — Output arguments from running function

Read-only: cell array

This property is read-only.

Output arguments from running the function, returned as a cell array.

This property is an empty cell array if the FevalFuture object is not finished running or the associated function finishes execution with an error. It becomes non-empty when you successfully run fetchOutputs on the FevalFuture object. The results are stored locally and fetchOutputs deletes the results from the server. Subsequent calls to fetchOutputs access this property rather than retrieving them from the server again.

Example: {[3.14]}

Data Types: cell

port — Port number of server

positive scalar

Port number of the MATLAB Production Server instance hosting the deployable archive that created the FevalFuture object, returned as a positive scalar.

Example: 9920

Data Types: uint8 | uint16

protocol — Protocol of request

"HTTP" | "HTTPS"

Protocol used to make the request to MATLAB Production Server, returned as "HTTP" or "HTTPS".

Request — Full URL of request

string scalar

Full URL of the request to MATLAB Production Server, returned as a string scalar in the form <protocol>://<host>:<port>/<path to request>.

SessionID — Session-ID header from server

string scalar

Value of the Session-ID header from the server, if one exists, returned as a string scalar.

State — Current state of future

Read-only: AsyncState enumeration member

This property is read-only.

Current state of the future, returned as one of these members of the AsyncState enumeration:

• 'Reading' — FevalFuture is being read by MATLAB Production Server and is not yet in the queue.

• 'inQueue' — FevalFuture is queued, and the function associated with it is scheduled to run.

• 'Processing' — Function associated with the FevalFuture is currently running.

• 'Ready' — Function associated with the FevalFuture is finished running.

• 'Error' — Function associated with the FevalFuture has produced an error.

• 'Cancelled' — Evaluation of the function associated with the FevalFuture has been cancelled.

• 'Deleted' — The FevalFuture has been deleted.

• 'Unknown' — Function associated with the FevalFuture is in an unknown state.

TerminalStates — List of terminal states

Read-only: 'Ready' | 'Error' | 'Cancelled'

This property is read-only.

List of terminal states, returned as one of these members of the AsyncState enumeration:

• 'Ready' — Function associated with the FevalFuture is finished running.

• 'Error' — Function associated with the FevalFuture has produced an error.

• 'Cancelled' — Evaluation of the function associated with the FevalFuture has been cancelled.

Object Functions

General Functions

cancel	Stop function running on MATLAB Production Server in the background
fetchOutputs	Retrieve results from function running on MATLAB Production Server in the background
wait	Wait for futures running on MATLAB Production Server to complete

Version History

Introduced in R2026b