Function

Summary

Flags an object for special action on garbage collection.

Package

hcl

Signature

flag-special-free-action object => t

Arguments

object

The object on which the special actions are to be performed. This cannot be a symbol.

Values

Returns t.

Description

Note that all the current special-free-action functions are performed on the object. Use flag-not-special-free-action to unflag an object.

Notes

Each object that is flagged for special free action adds some overhead to every garbage collection. This is not significant for a small number of objects, but calling flag-special-free-action with a large number of objects may slow the system significantly. Thus you should avoid using special free actions where possible. Normally, they should be used only for objects that keep some external resources which need to be freed.

Example

CL-USER 29 > (make-instance 'capi:title-pane)

#<CAPI:TITLE-PANE "" 20F9898C>

CL-USER 30 > (flag-special-free-action *)

T

See also

add-special-free-action
flag-not-special-free-action
remove-special-free-action