Add the possibility to terminate Web Workers #31
Conversation
This adds a `.terminateWorker` method to the lzma object which, if appropiate, terminates the associated web worker.
Added .terminateWorker() to be able to garbage collect the Web Worker.
| @@ -2628,7 +2628,8 @@ var LZMA = (function () { | |||
| return { | |||
| /** xs */ | |||
| compress: compress, | |||
| decompress: decompress | |||
| decompress: decompress, | |||
| terminateWorker: function() {} | |||
There was a problem hiding this comment.
I assume this was added to match lzma.js, but I'm wondering if maybe leaving it out is better since calling this terminateWorker() doesn't do anything. Perhaps it's better to just let it throw an error and let the coder check to see if it exists. Thoughts?
There was a problem hiding this comment.
Exactly, I thought it might be good to have a consistent API across the platforms. I agree that it probably does not make a lot of difference, since this version of terminateWorker is only used when using Node.js or similar, where the code author will know for sure that there are no web workers involved.
I can’t really tell how much code using this module is expected to run both server-side and client-side; If you don’t think it’s a notable amount, you can just drop it.
There was a problem hiding this comment.
I’ve done some thinking about this, and maybe it would be even better to have some way of accessing the web worker object itself (e.g. LZMA().worker(), which would return null/undefined/… in case there is no worker); Then, users could call .terminate() themselves. This might be a little more intuitive and would have the advantage of providing access to other parts of the Web Worker API (and especially future additions to it).
This adds a
.terminateWorkermethod to thelzmaobject, which terminates the associated web worker (if web workers are available and have been used).A possible (and my intended) use case is to use multiple
LZMA()instances in parallel in order to increase overall compression speed; Since Web Workers, however, don’t seem to abide by the normal garbage collection rules, this requires some way of stopping them once their work is done.