discard-process-pool

Arguments: pool &key forget kill

This function returns nil after deleting the argument process-pool.

pool can be nil (indicating the default process-pool, see ensure-default-process-pool) or a process-pool object.

If the default process pool is deleted, there will be no default process pool available until ensure-default-process-pool is called (and so forms like (process-pool-run nil ...), which try to run a process in the default pool, will fail):

cl-user(34): (ensure-default-process-pool)
#<process-pool @ #x100034f0272>
cl-user(35): (process-pool-run nil :function 'foo)
:created
cl-user(36): (discard-process-pool nil)
nil
cl-user(37): (process-pool-run nil :function 'foo)
Error: There is no default process pool.

The keyword arguments:

• forget: If non-nil, discard any work-items in the queue. If nil (the default), signal a continuable error if there are work-items in the queue.
• kill: If non-nil, kill any active processes still running. If nil (the default), leave any active processes to run to the end of their current task.

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.