tmon

Index Home MAE > MAE Architecture > MAE Utilities > tmon

tmon

This command provides a text-based client user interface to monitor MAE modules.

The command syntax is:

tmon

A monitor is a direct interface to a MAE daemon or application.  That daemon or application must specifically implement a monitor interface for tmon to communicate to; not all daemons or applications permit a monitor connection.

tmon Commands

Some commands are universal across all monitor interfaces, however most commands are specific to the module that is connected to.  For module-specific documentation, see that daemon/application.

Command

Description

quit

Exit tmon.

help

Show help.

module modulename

Attach to the module named. The module must already be enabled for a monitor connection, otherwise you'll see the "Invalid module" error.

other

A number of other commands are available, too, but are specific to the module. For example, the magic daemon has a monitor that supports a number of commands.


Enabling a Daemon/App for Monitor

The monitor interface is implemented as an RPC service (RemoteService) with the name module.monitor. The above monitor command attempts to connect to the RPC service; if it can't, it outputs the Invalid module error.

The module.monitor service is implemented with two parameters:

Parameter

Value

cmd

This is the text string provided by the user.  This needs to be parsed per the app's syntax.  Any result should be returned in the variable output from the RPC call. The value of output will be display to the user.

session

This is not shared with the user; this is session-specific data that is provided along with each cmd sent. The app monitor returns the session, updated or not; whatever is returned will be sent with the next cmd.