MATLAB Runtime Server

Summary List: MATLAB Runtime Engine Application

This list summarizes the steps for creating a MATLAB runtime engine application. The hyperlinks lead to the sections that describe the steps in more detail. Note that some links point to the chapter about MATLAB runtime GUI applications because the topic is the same for both types of application.

1. Stamp your development copy of MATLAB.
2. Adapt the design of the MATLAB portion of the application as necessary. See Design Issues for a Runtime Application.
3. Decide where to place the MATLAB files you write for the runtime application.
   • If you keep all files under toolbox, then remember to use rehash toolboxreset to register each change you make.
   • If you keep the M-files outside of toolbox and move the P-files under toolbox only towards the end of your development and testing process, then remember to include the final destination directories in pathdefrt.

MATLAB places no restriction on the directory structure of the non-MATLAB portion of your application and no restriction on the relative locations of the MATLAB and non-MATLAB portions of your application.

4. Create the startup function matlabrt.m by copying toolbox\runtime\matlabrt_template.m to toolbox\local and renaming it matlabrt.m. Then modify it as necessary and use rehash toolboxreset to register the change.

Note that PC applications have special startup considerations arising from multiple versions or instances of MATLAB.

5. Create the path definition function pathdefrt.m by copying toolbox\runtime\pathdefrt_template.m to toolbox\local and renaming it pathdefrt.m. Then modify it as necessary and use rehash toolboxreset to register the change.
   • Use cleanp to remove any .p files from your path and current directory.
   • Use depdir to determine the runtime path.
   • If you plan to move your P-files under toolbox later on, then include their destination directories in the runtime path.
   • Place pathdefrt.m in toolbox\local and use rehash toolboxreset to register the change.
6. Use buildp to compile all application M-files into runtime P-files.
   • Possible complications: toolbar or menu items, functions invoked by eval, MATLAB P-files, MATLAB add-on products
   • Also see the buildp log file for information about the compilation process
7. Test the application.
   • With your P-files in their final locations under toolbox, if they are not already there. After moving them, use rehash toolboxreset to register the changes.
   • Test the MATLAB portion by having MATLAB emulate the Runtime Server (different procedures for ActiveX and Engine API applications).
   • Test the entire application with the Runtime Server variant.

Return to earlier steps as necessary. When debugging, remember to stay current by deleting old P-files, producing new P-files whenever an M-file changes, and using rehash toolboxreset as necessary to register changes.

Testing with the Runtime Server Variant

Shipping a MATLAB Runtime Application