cancel-process-pool-worker

Arguments: &optional reason

When called from the body of a process-pool-work-item worker function or from the body of a report-start or report-end function (see process-pool-report-start and process-pool-report-end), the ultimate effect is to terminate the worker process. If a work-item is present (see mp:process-pool-run), the reason argument is saved in the error slot of the work-item.

When called in a report-start function while a work-item is being run, the report-start function exits immediately, the work function is not called, and the report-end function is called. When called in the work function, the work function exits immediately and the report-end function is called. When called in a report-end function, that function exits immediately.

When called in any other context, this function returns nil but does nothing else.

The related function cancel-process-pool-work stops running the report-start function or the work-item work function but does not kill the process-pool process running the work-item. That function called in a report-end function does nothing except return nil.

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.