procedures.tcl Annotations

A library for managing user defined procedures within a session and across sessions. Note: Registration/unregistration of commands can have security implications. These procedures, however, do not enforce any policy with respect to AUTHMODE. For the sake of flexibility this security policies are left to be enforced via other means, (e.g. MikroConf command visibility).

Procedure Detail

getlist

proc getlist {  }

Get the list of currently registered procedures.

Defined in:

procedures.tcl, line 96

getproc

proc getproc { name }

Retrieve a specific registered procedure.

Parameters:

name - The name of the procedure to get.

Returns:

A list with the followng elements of a procedure: Name Args Body @error

Defined in:

procedures.tcl, line 106

invoke

proc invoke { name args }

Call a procedure registered in the Event interpreter.

Parameters:

name - Name of registered procedure.

args - Additional arguments to pass to the procedure.

Returns:

Whatever returned by the called procedure.

Defined in:

procedures.tcl, line 121

register

proc register { sid name }

Register a previously declared procedure (using the 'proc' Tcl command). Newly registered procs will be fully usable within the session that they where defined, but on any other concurent session they will not become available. Only new sessions will have those new procs present. If a procedure is already registered, then it is updated. The Events Session is always kept in sync with what is registered/unregistered, so no need to restart that Sesison. We cannot do that with user sessions, because parallel user sessions might have defined the same name procedure with different body, and we cannot just spontaneously overwrite them. Note: When registering a procedure the state of the procedure at the moment of registration is recorded. Therefore when issuing "save" any changes that occured since registration will not be saved. @assume $name follows naming conventions

Parameters:

sid - Session Id.

name - The name of the procedure to register. @error

Defined in:

procedures.tcl, line 50

unregister

proc unregister { name }

Unregister a previously registered procedure. As with "register", changes will only take effect in new sessions, and at once on the Events Session.

Parameters:

name - the name of the procedure to unregister. @error

Defined in:

procedures.tcl, line 81