cancel-process-pool-work

Arguments: &rest reason-and-values

This function stops executing a report-start function or a work-item work function without killing the process-pool process running the work item (as cancel-process-pool-worker does).

When called from the body of a report-start function, the report-start function exits immediately and the work function is not called. The report-end function is called.

When called from the body of a work-item work function, the work function exits immediately and then the report-end function is called.

In either case, if any reason-and-values arguments are supplied, the first is saved in the error slot of work-item and a list of the remaining arguments is stored in the values slot.

When called in any other context, including in a report-end function, this function returns nil but does nothing else. The reason-and-values arguments, if any, are ignored.

See Process pools in multiprocessing.htm for more information on process pools.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page is new in the 10.1 release.
Created 2019.8.20.