Module Conventions

<class>

Identifying a class of objects. For instance, in the call

Connections list

Connections is the class of all connections to the browser. The call will return a list of the names of all the connections.

<class>:<instanceId>

Identifying an object (instance of a class). For instance, in the call

StartableServers:Recognizer start

StartableServers:Recognizer identifies a StartableServer by the name Recognizer. The call will cause the server to be started.

<class>:<instanceId>.<attribute>

Identifies an attribute of the object. For instance, in the call

StartableServers:Recognizer.commandLine get

commandLine is an attribute of the StartableServer Recognizer. The call will return the commandLine for the Recognizer.

If the value of an attribute of the object is an object itself, one might have identifiers like:

StartableServers:Recognizer.connection.state get

Where connection is an attribute of the recognizer StartableServer, and state is an attribute of the connection.

StartableServers."My Server"

StartableServers."My \"Server\""

Subscriptions

These functions work as follows. <publication> is the name of an object which one can subscribe to.

<publication> subscribe <moduleName> <moduleData>

<subscriptionId>

Subscribes to the publication. moduleName is the name of the module which will be informed of changes to the object. moduleData is value supplied by the subscriber to identify the subscription. It will be included in the notification calls.

The result is an identifier used to refer to this subscription in future calls.

When the object changes, moduleName receives a call of the form:

Subscription.<moduleData> notify <notification message>

If for some reason the module with the publication wishes to cancel the subscription, it will make a call like:

Subscription.<moduleData> cancel

<publication> cancelSubscription <subscriptionId>

none

Cancels the subscription.

© Copyright 1997, 1998 Erland Lewin and the members of the Center for Speech Technology