Commit 0488782
doc: non-partitioned async crypto operations
Neither crypto.randomBytes nor crypto.randomFill
partitions the work submitted to the threadpool.
This change was suggested during the discussion of #17054.
See also #17154.
PR-URL: #17250
Refs: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>1 parent 0443909 commit 0488782
1 file changed
Lines changed: 10 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1826,6 +1826,11 @@ Note that this API uses libuv's threadpool, which can have surprising and | |||
| 1826 | 1826 | negative performance implications for some applications, see the | |
| 1827 | 1827 | [`UV_THREADPOOL_SIZE`][] documentation for more information. | |
| 1828 | 1828 | ||
| 1829 | + *Note*: The asynchronous version of `crypto.randomBytes()` is carried out | ||
| 1830 | + in a single threadpool request. To minimize threadpool task length variation, | ||
| 1831 | + partition large `randomBytes` requests when doing so as part of fulfilling a | ||
| 1832 | + client request. | ||
| 1833 | + | ||
| 1829 | 1834 | ### crypto.randomFillSync(buffer[, offset][, size]) | |
| 1830 | 1835 | <!-- YAML | |
| 1831 | 1836 | added: v7.10.0 | |
@@ -1933,6 +1938,11 @@ Note that this API uses libuv's threadpool, which can have surprising and | |||
| 1933 | 1938 | negative performance implications for some applications, see the | |
| 1934 | 1939 | [`UV_THREADPOOL_SIZE`][] documentation for more information. | |
| 1935 | 1940 | ||
| 1941 | + *Note*: The asynchronous version of `crypto.randomFill()` is carried out | ||
| 1942 | + in a single threadpool request. To minimize threadpool task length variation, | ||
| 1943 | + partition large `randomFill` requests when doing so as part of fulfilling a | ||
| 1944 | + client request. | ||
| 1945 | + | ||
| 1936 | 1946 | ### crypto.setEngine(engine[, flags]) | |
| 1937 | 1947 | <!-- YAML | |
| 1938 | 1948 | added: v0.11.11 | |
0 commit comments