aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc/src/erl_nif.xml
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2016-04-15 14:50:39 +0200
committerLukas Larsson <[email protected]>2016-04-15 14:50:39 +0200
commit67df3b3792857a2b4885c0acbeaa7f32f3594b0c (patch)
tree57b7749d36fa3b60560cbfcf9a196006de10af95 /erts/doc/src/erl_nif.xml
parent8d2ea920456c5db3f123ebc19b8b8e398db2e2d5 (diff)
parent57551877d85ad7659201235e27498be42809fefb (diff)
downloadotp-67df3b3792857a2b4885c0acbeaa7f32f3594b0c.tar.gz
otp-67df3b3792857a2b4885c0acbeaa7f32f3594b0c.tar.bz2
otp-67df3b3792857a2b4885c0acbeaa7f32f3594b0c.zip
Merge branch 'lukas/erts/enif_send_null_env/OTP-13495'
* lukas/erts/enif_send_null_env/OTP-13495: erts: Add enif_send with NULL as msg env
Diffstat (limited to 'erts/doc/src/erl_nif.xml')
-rw-r--r--erts/doc/src/erl_nif.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index b7839cec33..5f56d8b595 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -1632,7 +1632,7 @@ enif_map_iterator_destroy(env, &amp;iter);
<tag><c>msg_env</c></tag>
<item>The environment of the message term. Must be a process
independent environment allocated with
- <seealso marker="#enif_alloc_env">enif_alloc_env</seealso>.</item>
+ <seealso marker="#enif_alloc_env">enif_alloc_env</seealso> or NULL.</item>
<tag><c>msg</c></tag>
<item>The message term to send.</item>
</taglist>
@@ -1641,6 +1641,8 @@ enif_map_iterator_destroy(env, &amp;iter);
<c>msg</c>) will be invalidated by a successful call to <c>enif_send</c>. The environment
should either be freed with <seealso marker="#enif_free_env">enif_free_env</seealso>
of cleared for reuse with <seealso marker="#enif_clear_env">enif_clear_env</seealso>.</p>
+ <p>If <c>msg_env</c> is set to NULL the <c>msg</c> term is copied and
+ the original term and its environemt is still valid after the call.</p>
<p>This function is only thread-safe when the emulator with SMP support is used.
It can only be used in a non-SMP emulator from a NIF-calling thread.</p>
<note><p>Passing <c>msg_env</c> as <c>NULL</c> is only supported since