aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc/src/erl_nif.xml
AgeCommit message (Collapse)Author
2018-12-12Add empty 'since' attribute for old modules and functionsSverker Eriksson
2018-12-11Add "since" attributes in xml for new functions and modulesSverker Eriksson
introduced after OTP_R13B03.
2018-11-29Replace mathematical jargon in erl_nif docs PR-2037Bartosz Błaszków
2018-11-21erts: Clarify erl_nif docs about callback environmentsSverker Eriksson
2018-10-01Fix spelling of intended in erl_nif docsLukas Larsson
2018-07-16erts: Clarify erl_nif docs of enif_*printf and %TSverker Eriksson
2018-07-09erts: Fix spec and docs for process_info 'monitored_by'Sverker Eriksson
to include ports and NIF resources. Added new opaque type 'nif_resource'.
2018-06-18Update copyright yearHenrik Nord
2018-04-06erts: Fix doc typo for enif_free_iovecSverker Eriksson
2018-03-23Add enif_make_map_from_arraysJohn Högberg
2018-03-22Merge branch 'sverker/enif-name-funcs/OTP-14994'Sverker Eriksson
2018-03-22erts: Remove const from ErlNifResourceDown docSverker Eriksson
to conform with erl_nif.h
2018-03-22erts: Add statement about errno to enif_*printf docsSverker Eriksson
2018-03-22erts: Add enif_vfprintf and enif_vsnprintfSverker Eriksson
2018-03-22erts: Add enif_*_name functionsSverker Eriksson
2018-03-16Merge pull request #1746 from legoscia/erl_nif.xml-spellingLukas Larsson
Fix typos in erl_nif.xml
2018-03-13Fix typos in erl_nif.xmlMagnus Henoch
2018-03-07erts: Add enif_fprintf docsSverker Eriksson
2018-02-26Merge branch 'maint'Sverker Eriksson
2018-02-26Suggest using enif_make_new_binary when possibleJohn Högberg
While enif_make_binary will create heap-binaries from ErlNifBinaries when possible now, enif_alloc_binary still allocates a Binary* off-heap which is avoided entirely with enif_make_new_binary.
2018-02-23erts: Clarify enif_self docsSverker Eriksson
2017-11-30Add enif_ioq_peek_headJohn Högberg
This introduces a way to retrieve erlang terms from NIF IO queues without having to resort to copying. OTP-14797
2017-11-23Document alignment guarantees of enif_alloc and enif_reallocAnthony Ramine
2017-11-21Document enif_reallocAnthony Ramine
2017-09-07Merge branch 'sverker/nif-resource-doc' into maintSverker Eriksson
* sverker/nif-resource-doc: erts: Update docs for enif_make_resource
2017-09-05erts: Update docs for enif_make_resourceSverker Eriksson
to include new defined properties in OTP-20 regarding comparison and serialization.
2017-09-05erts: Add nif ioqLukas Larsson
2017-05-22Add enif_whereis_...() functionsTed Burghart
#### Why do we need this new feature? There are cases when a NIF needs to send a message, using `enif_send()`, to a long-lived process with a registered name. A common use-case is logging, where asynchronous fire-and-forget messages are the norm. There can also be cases where a yielding or dirty NIF or background thread may request a callback from a service with additional information it needs to complete its operation, yielding or waiting (with suitable timeouts, etc) until its state has been updated through the NIF module's API. NIFs can only send messages to pids, and the lack of name resolution leaves a complicated dance between separate monitoring processes and the NIF as the only way to keep a NIF informed of the whereabouts of such long-lived processes. Providing a reliable, built-in facility for NIFs to resolve process (or port) names simplifies these use cases considerably. #### Risks or uncertain artifacts? Testing has not exposed any significant risk. The implementation behaves as expected on regular and dirty scheduler threads as well as non-scheduler threads. By constraining the `enif_whereis_...()` functions to their minimal scopes and using patterns consistent with related functions, the implementation, testing, and maintenance burden is low. The API and behavior of existing functions is unchanged. #### How did you solve it? While extending `enif_send()` to operate on a pid or an atom (as `erlang:send/2` does) was attractive, it would have entailed changing the type of its `to_pid` parameter and thereby breaking backward compatibility. The same consideration applies to `enif_port_command()`. That leaves a choice between 1, 2, or 3 new functions: 1. `enif_whereis()` 2. `enif_whereis_pid()` and `enif_whereis_port()` 3. All of the above. While option (1), directly mimicking the behavior of `erlang:whereis/1`, is appealing, it poses potential problems if `pid()` or `port()` are subsequently implemented as non-integral types that must be bound to an owning `ErlNifEnv` instance. Therefore, option (2) has been chosen to use `ErlNifPid`/`ErlNifPort` structures in the API to maintain proper term ownership semantics.
2017-05-10erts: Improve erl_nif docsSverker Eriksson
2017-05-04Update copyright yearRaimo Niskanen
2017-04-24erts: Discontinue salted use of enif_hash/phash2Guilherme Andrade
2017-04-22erts: Allow for easier future enif_hash expansionGuilherme Andrade
Allow for expanding support to 64-bit hashes without breaking the interface.
2017-04-22erts: Improve enif_hash documentationGuilherme Andrade
2017-04-22erts: Support custom salt in enif_hashGuilherme Andrade
2017-04-20erts: Refactor enif_phash2 into enif_hashGuilherme Andrade
A more generic hashing function which can also hash terms based on `make_internal_hash'.
2017-04-20erts: Remove enif_phash2_rangedGuilherme Andrade
2017-04-19erts: Add enif_phash2 and enif_phash2_rangedGuilherme Andrade
These allow one to hash VM terms from NIF code.
2017-03-07erts: Fix xml lint warning for erl_nifSverker Eriksson
2017-02-22Add docs for enif_compare_monitors and ErlNifMonitorSverker Eriksson
2017-02-20Fix erl_nif docSverker Eriksson
2017-02-20Merge branch 'master' into sverker/enif_selectSverker Eriksson
Conflicts: erts/emulator/beam/erl_binary.h erts/emulator/beam/erl_monitors.c erts/emulator/beam/erl_nif.c erts/emulator/beam/global.h erts/emulator/test/nif_SUITE_data/nif_SUITE.c
2017-02-09erts: Change return value for enif_selectSverker Eriksson
to negative int as error and positive as success.
2017-02-09erts: Add pid argument to enif_selectSverker Eriksson
2017-02-09erts: Add enif_monitor_process and enif_demonitor_processSverker Eriksson
2017-02-03Merge branch 'master' into sverker/enif_selectSverker Eriksson
2017-01-18Change exception for enif_schedule_nif() with dirty flagsRickard Green
2017-01-17Remove experimental disclaimer on dirty schedulersRickard Green
2016-12-19Add ErlNifSelectReturnSverker Eriksson
2016-12-19Add stop arguments: fd and is_direct_callSverker Eriksson
2016-12-19erts: Add some improvements to erl_nif docsSverker Eriksson