NAME

shtk_cleanup_register —

Installs cleanup handlers to be called on script termination

LIBRARY

shtk_import cleanup

SYNOPSIS

shtk_cleanup_register handler1 [.. handlerN]

DESCRIPTION

The shtk_cleanup_register function installs one or more cleanup handlers, given in the handler1 to handlerN arguments as function names.

The registered handlers are executed in the order they are originally registered. Registration of handlers is idempotent.

EXAMPLES

The following example creates a temporary file and installs a cleanup handler to ensure that the file gets removed when the script terminates:

local pattern="${TMPDIR:-/tmp}/my_program.XXXXXX"

local temp_file="$(mktemp "${pattern}" 2>/dev/null)"
[ -f "${temp_file}" ] || shtk_cli_error "Failed to create temporary file"

eval "remove_temp_file() { rm -f '${temp_file}'; }"
shtk_cleanup_register remove_temp_file

HISTORY

shtk_cleanup_register first appeared in shtk 1.4.