matlab.production_server.client.MWHttpAsyncClient

R2026b

Namespace: matlab.production_server

Python object encapsulating a connection to a MATLAB Production Server instance for making non-blocking function calls

Description

The matlab.production_server.client.MWHttpAsyncClient class creates a connection object that encapsulates the connection between the client and a MATLAB^® Production Server™ instance. Once the connection is created, you can make non-blocking calls to MATLAB functions hosted on the server instance.

Construction

my_client = MWHttpAsyncClient(url,[ssl_context=ssl_context])

Input Arguments

url — URL of the server instance to connect to

string

URL of the server instance to which the client connects, specified as a string. This server instance hosts the MATLAB functions which the client can evaluate.

ssl_context — SSLContext object that specifies the SSL protocol to use for client-server communication

None (default) | ssl.SSLContext object

SSL protocol to use for client-server communication, specified as an ssl.SSLContext object. The Python^® client library uses the Python ssl library library for supporting HTTPS requests to server instances. For information about the SSL protocols that the server supports, see ssl-protocols.

This argument is required if the URL to connect to the server instance uses HTTPS.

HTTPS communication using the Python client API is supported only on Windows^® and Linux^® platforms. macOS is not supported.

Examples

Initialize Client and Call Function Deployed to MATLAB Production Server

Initialize the client to run functions deployed to a MATLAB Production Server instance running on localhost:9910.

from production_server import async_client
client = async_client.MWHttpAsyncClient("http://localhost:9910"))

Call function myFunc from archive myArchive with 2 inputs and 3 outputs, using double-dot syntax to specify the archive and the function to call. The client outputs a matlab.production_server.client.Future object.

future = client.myArchive.myFunc(input1, input2, nargout=3)

More About

Asynchronous Function Invocation

Asynchronous function calls take the form <output> = <client>.<archive>.<function>(*args, nargout, timeout_ms). output is a future object representing the result of the asynchronous call made by client to function contained in archive. You specify the input arguments to function, the number of outputs as the name-value argument nargout, and the timeout in milliseconds as the name-value argument timeout_ms.

Data Exchange Between MATLAB Production Server and Python

MATLAB Production Server implicitly converts Python data to equivalent MATLAB types when the data is passed to a deployed function. Similarly, when data is returned by the function, MATLAB Production Server converts the MATLAB data to equivalent Python data types. For more information about passing data between MATLAB Production Server and Python, including a table of equivalent types, see Pass Data Between MATLAB Production Server and Python.