5.3 Documentation addenda

reset-monitors

Syntax:

reset-monitor function-or-method &key :number-of-calls
                                      :inclusive-consing
                                      :exclusive-consing
                                      :inclusive-time
                                      :exclusive-time
                                                                   reset-monitors

The function-or-method argument to reset-monitor specifies a function name, a method object, or the name of a method for which monitoring counts should be reset. A method name has the following form:

 (method generic-function-name {qualifiers}* 
                                  ({specializer-name}*)) 

The function reset-monitor accepts the following keyword arguments:

• :number-of-calls

If this keyword argument has a non-nil value, the count for the number of invocations of the specified function is reset to 0.

• :inclusive-consing

If this keyword argument has a non-nil value, the count for the number of words of storage allocated for this function and for all the functions that it calls is reset to 0.

• :exclusive-consing

If this keyword argument has a non-nil value, the count for the number of words of storage allocated exclusively for this function is reset to 0.

• :inclusive-time

If this keyword argument has a non-nil value, the count for the number of seconds spent in this function and in the functions that it calls is reset to 0.:

• exclusive-time

If this keyword argument has a non-nil value, the count for the number of seconds spent exclusively in this function is reset to 0.

The default value for all of these arguments is t.

You should reset monitoring counts for a function or method whenever you have modified its definition and would like to examine fresh monitoring results. If you are running several different test cases to gather monitoring information and thus want cumulative results, do not reset the counts between tests.

The functions reset-monitor and reset-monitors always return nil. If the Performance Monitor was enabled before either of these functions is called, it is disabled while the counts are being cleared.

Generated with Harlequin WebMaker