make-process-pool-work-item

Arguments: &key name function arguments data report-start report-end work

This function either creates a new process-pool-work-item or modifies an existing one, depending on the value of the work keyword argument. If work is nil or unspecified, a new process-pool-work-item is created and returned. If it is an existing, idle process-pool-work-item, that one is modified according to the values of the other arguments and returned. Modifying a work-item that is not idle, while legal, may have unexpected results unless care is taken to ensure predictable behavior. A work-item is idle when process-pool-work-item-active-p returns nil when applied to the work-item.

process-pool-run will create a process-pool-work-item on its own (and either start running it or add it to its queue), so creating them using this function is not necessary.

The keyword arguments other than work (name, function, arguments, data, report-start, and report-end) define the work-item attributes. All are also arguments to process-pool-run. See the description of that function for information on these arguments. process-pool-run also accepts the keyword argument queue-p. That is not an argument to make-process-pool-work-item.

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.