Page tree

Preliminary documentation for Ice for MATLAB. Do not use in production applications. Refer to the space directory for other releases.

Skip to end of metadata
Go to start of metadata

Every Ice-based application needs to initialize the Ice run time, and this initialization returns an Ice::Communicator object.

Communicator is a local MATLAB object that represents an instance of the Ice run time. Most Ice-based applications create and use a single Communicator object, although it is possible and occasionally desirable to have multiple Communicator objects in the same application.

You initialize the Ice run time by calling  Ice.initialize, for example:

MATLAB
[communicator, remainingArgs] = Ice.initialize(args);

Ice.initialize accepts an optional argument list. The function scans the argument list for any command-line options that are relevant to the Ice run time; any such options are removed from the argument list so, when Ice.initialize returns, the only options and arguments remaining in remainingArgs are those that concern your application. If anything goes wrong during initialization, initialize throws an exception.

Before leaving your program, you must call Communicator.destroy. The destroy method is responsible for finalizing the Ice run time. In particular,  destroy ensures that any outstanding threads started by the underlying Ice C++ run-time are joined with and reclaims a number of operating system resources, such as file descriptors and memory. Never allow your program to terminate without calling destroy first.

The general shape of our Ice MATLAB application is therefore:

MATLAB
communicator = Ice.initialize(args); % here we ignore the remaining args
cleanup = onCleanup(@() communicator.destroy());

You can safely call destroy multiple times on a communicator. destroy does not throw any exception.


See Also

  • No labels