File 0709-erts-Add-some-erl_nif-doc-clarifications.p... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0709-erts-Add-some-erl_nif-doc-clarifications.patch of Package erlang

From 7d54af059fffd27286f6a236470a9096c09921a9 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Wed, 22 May 2019 17:48:00 +0200
Subject: [PATCH 2/2] erts: Add some erl_nif doc clarifications

---
 erts/doc/src/erl_nif.xml | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index f88d255296..d74ae23a93 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -1495,6 +1495,9 @@ enif_free_iovec(iovec);]]></code>
 <c>term</c>.
 Returns <c>true</c> on success, or <c>false</c> if <c>term</c> is
 not a handle to a resource object of type <c>type</c>.
+	<c>enif_get_resource</c> does not add a reference to the resource
+	 object. However, the pointer received in <c>*objp</c> is guaranteed to
+	 be valid at least as long as the resource handle <c>term</c> is valid.
 </desc>
 </func>
 
@@ -2947,6 +2950,10 @@ enif_map_iterator_destroy(env, &amp;iter);</code>
 References made by <seealso marker="#enif_make_resource">
 <c>enif_make_resource</c></seealso>
 can only be removed by the garbage collector.
+	There are no guarantees exactly when the destructor of an
+	 unreferenced resource is called. It could be called directly by
+	 <c>enif_release_resource</c> but it could also be scheduled to be
+	 called at a later time possibly by another thread.
 </desc>
 </func>
 
-- 
2.16.4

Places

File 0709-erts-Add-some-erl_nif-doc-clarifications.patch of Package erlang

Places