API functions for an Erlang NIF library.
A NIF library contains native implementation of some functions of an Erlang module. The native implemented functions (NIFs) are called like any other functions without any difference to the caller. Each NIF must have an implementation in Erlang that is invoked if the function is called before the NIF library is successfully loaded. A typical such stub implementation is to throw an exception. But it can also be used as a fallback implementation if the NIF library is not implemented for some architecture.
Once loaded, a NIF library is persistent. It will not be unloaded until the module code version that it belongs to is purged.
All interaction between NIF code and the Erlang runtime system is performed by calling NIF API functions. Functions exist for the following functionality:
void *enif_alloc(size_t size)
Allocates memory of size
bytes.
Returns NULL
if the allocation fails.
The returned pointer is suitably aligned for any built-in type that fit in the allocated memory.
int enif_alloc_binary(size_t size, ErlNifBinary* bin)
Allocates a new binary of size size
bytes. Initializes the structure pointed to by bin
to refer to the allocated binary. The binary must either be released by enif_release_binary
or ownership transferred to an Erlang term with enif_make_binary
. An allocated (and owned) ErlNifBinary
can be kept between NIF calls.
If you do not need to reallocate or keep the data alive across NIF calls, consider using enif_make_new_binary
instead as it will allocate small binaries on the process heap when possible.
Returns true
on success, or false
if allocation fails.
ErlNifEnv *enif_alloc_env()
Allocates a new process-independent environment. The environment can be used to hold terms that are not bound to any process. Such terms can later be copied to a process environment with enif_make_copy
or be sent to a process as a message with enif_send
.
Returns pointer to the new environment.
void *enif_alloc_resource(ErlNifResourceType* type, unsigned size)
Allocates a memory-managed resource object of type type
and size size
bytes.
size_t enif_binary_to_term(ErlNifEnv *env, const unsigned char* data, size_t size, ERL_NIF_TERM *term, ErlNifBinaryToTerm opts)
Creates a term that is the result of decoding the binary data at data
, which must be encoded according to the Erlang external term format. No more than size
bytes are read from data
. Argument opts
corresponds to the second argument to erlang:binary_to_term/2
and must be either 0
or ERL_NIF_BIN2TERM_SAFE
.
On success, stores the resulting term at *term
and returns the number of bytes read. Returns 0
if decoding fails or if opts
is invalid.
See also ErlNifBinaryToTerm
, erlang:binary_to_term/2
, and enif_term_to_binary
.
void enif_clear_env(ErlNifEnv* env)
Frees all terms in an environment and clears it for reuse. The environment must have been allocated with enif_alloc_env
.
int enif_compare(ERL_NIF_TERM lhs, ERL_NIF_TERM rhs)
Returns an integer < 0
if lhs
< rhs
, 0
if lhs
= rhs
, and > 0
if lhs
> rhs
. Corresponds to the Erlang operators ==
, /=
, =<
, <
, >=
, and >
(but not =:=
or =/=
).
int enif_compare_monitors(const ErlNifMonitor *monitor1, const ErlNifMonitor *monitor2)
Compares two ErlNifMonitor
s. Can also be used to imply some artificial order on monitors, for whatever reason.
Returns 0
if monitor1
and monitor2
are equal, < 0
if monitor1
< monitor2
, and > 0
if monitor1
> monitor2
.
void enif_cond_broadcast(ErlNifCond *cnd)
Same as erl_drv_cond_broadcast
.
ErlNifCond *enif_cond_create(char *name)
Same as erl_drv_cond_create
.
void enif_cond_destroy(ErlNifCond *cnd)
Same as erl_drv_cond_destroy
.
char*enif_cond_name(ErlNifCond* cnd)
Same as erl_drv_cond_name
.
void enif_cond_signal(ErlNifCond *cnd)
Same as erl_drv_cond_signal
.
void enif_cond_wait(ErlNifCond *cnd, ErlNifMutex *mtx)
Same as erl_drv_cond_wait
.
int enif_consume_timeslice(ErlNifEnv *env, int percent)
Gives the runtime system a hint about how much CPU time the current NIF call has consumed since the last hint, or since the start of the NIF if no previous hint has been specified. The time is specified as a percent of the timeslice that a process is allowed to execute Erlang code until it can be suspended to give time for other runnable processes. The scheduling timeslice is not an exact entity, but can usually be approximated to about 1 millisecond.
Notice that it is up to the runtime system to determine if and how to use this information. Implementations on some platforms can use other means to determine consumed CPU time. Lengthy NIFs should regardless of this frequently call enif_consume_timeslice
to determine if it is allowed to continue execution.
Argument percent
must be an integer between 1 and 100. This function must only be called from a NIF-calling thread, and argument env
must be the environment of the calling process.
Returns 1
if the timeslice is exhausted, otherwise 0
. If 1
is returned, the NIF is to return as soon as possible in order for the process to yield.
This function is provided to better support co-operative scheduling, improve system responsiveness, and make it easier to prevent misbehaviors of the VM because of a NIF monopolizing a scheduler thread. It can be used to divide length work
into a number of repeated NIF calls without the need to create threads.
See also the warning
text at the beginning of this manual page.
ErlNifTime enif_convert_time_unit(ErlNifTime val, ErlNifTimeUnit from, ErlNifTimeUnit to)
Converts the val
value of time unit from
to the corresponding value of time unit to
. The result is rounded using the floor function.
val
- Value to convert time unit for.
from
- Time unit of
val
. to
- Time unit of returned value.
Returns ERL_NIF_TIME_ERROR
if called with an invalid time unit argument.
See also ErlNifTime
and ErlNifTimeUnit
.
ERL_NIF_TERM enif_cpu_time(ErlNifEnv *)
Returns the CPU time in the same format as erlang:timestamp()
. The CPU time is the time the current logical CPU has spent executing since some arbitrary point in the past. If the OS does not support fetching this value, enif_cpu_time
invokes enif_make_badarg
.
int enif_demonitor_process(ErlNifEnv* env, void* obj, const ErlNifMonitor* mon)
Cancels a monitor created earlier with enif_monitor_process
. Argument obj
is a pointer to the resource holding the monitor and *mon
identifies the monitor.
Returns 0
if the monitor was successfully identified and removed. Returns a non-zero value if the monitor could not be identified, which means it was either
- never created for this resource
- already cancelled
- already triggered
- just about to be triggered by a concurrent thread
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.
int enif_equal_tids(ErlNifTid tid1, ErlNifTid tid2)
Same as erl_drv_equal_tids
.
int enif_fprintf(FILE *stream, const char *format, ...)
Similar to fprintf
but this format string also accepts "%T"
, which formats Erlang terms.
This function was originally intenden for debugging purpose. It is not recommended to print very large terms with %T
. The function may change errno
, even if successful.
void enif_free(void* ptr)
Frees memory allocated by enif_alloc
.
void enif_free_env(ErlNifEnv* env)
Frees an environment allocated with enif_alloc_env
. All terms created in the environment are freed as well.
void enif_free_iovec(ErlNifIOvec* iov)
Frees an io vector returned from enif_inspect_iovec
. This is needed only if a NULL
environment is passed to enif_inspect_iovec
.
ErlNifIOVec *iovec = NULL;
size_t max_elements = 128;
ERL_NIF_TERM tail;
if (!enif_inspect_iovec(NULL, max_elements, term, &tail, &iovec))
return 0;
// Do things with the iovec
/* Free the iovector, possibly in another thread or nif function call */
enif_free_iovec(iovec);
int enif_get_atom(ErlNifEnv* env, ERL_NIF_TERM term, char* buf, unsigned size, ErlNifCharEncoding encode)
Writes a NULL
-terminated string in the buffer pointed to by buf
of size size
, consisting of the string representation of the atom term
with encoding encode
.
Returns the number of bytes written (including terminating NULL
character) or 0
if term
is not an atom with maximum length of size-1
.
int enif_get_atom_length(ErlNifEnv* env, ERL_NIF_TERM term, unsigned* len, ErlNifCharEncoding encode)
Sets *len
to the length (number of bytes excluding terminating NULL
character) of the atom term
with encoding encode
.
Returns true
on success, or false
if term
is not an atom.
int enif_get_double(ErlNifEnv* env, ERL_NIF_TERM term, double* dp)
Sets *dp
to the floating-point value of term
.
Returns true
on success, or false
if term
is not a float.
int enif_get_int(ErlNifEnv* env, ERL_NIF_TERM term, int* ip)
Sets *ip
to the integer value of term
.
Returns true
on success, or false
if term
is not an integer or is outside the bounds of type int
.
int enif_get_int64(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifSInt64* ip)
Sets *ip
to the integer value of term
.
Returns true
on success, or false
if term
is not an integer or is outside the bounds of a signed 64-bit integer.
int enif_get_local_pid(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifPid* pid)
If term
is the pid of a node local process, this function initializes the pid variable *pid
from it and returns true
. Otherwise returns false
. No check is done to see if the process is alive.
int enif_get_local_port(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifPort* port_id)
If term
identifies a node local port, this function initializes the port variable *port_id
from it and returns true
. Otherwise returns false
. No check is done to see if the port is alive.
int enif_get_list_cell(ErlNifEnv* env, ERL_NIF_TERM list, ERL_NIF_TERM* head, ERL_NIF_TERM* tail)
Sets *head
and *tail
from list list
.
Returns true
on success, or false
if it is not a list or the list is empty.
int enif_get_list_length(ErlNifEnv* env, ERL_NIF_TERM term, unsigned* len)
Sets *len
to the length of list term
.
Returns true
on success, or false
if term
is not a proper list.
int enif_get_long(ErlNifEnv* env, ERL_NIF_TERM term, long int* ip)
Sets *ip
to the long integer value of term
.
Returns true
on success, or false
if term
is not an integer or is outside the bounds of type long int
.
int enif_get_map_size(ErlNifEnv* env, ERL_NIF_TERM term, size_t *size)
Sets *size
to the number of key-value pairs in the map term
.
Returns true
on success, or false
if term
is not a map.
int enif_get_map_value(ErlNifEnv* env, ERL_NIF_TERM map, ERL_NIF_TERM key, ERL_NIF_TERM* value)
Sets *value
to the value associated with key
in the map map
.
Returns true
on success, or false
if map
is not a map or if map
does not contain key
.
int enif_get_resource(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifResourceType* type, void** objp)
Sets *objp
to point to the resource object referred to by term
.
Returns true
on success, or false
if term
is not a handle to a resource object of type type
.
int enif_get_string(ErlNifEnv* env, ERL_NIF_TERM list, char* buf, unsigned size, ErlNifCharEncoding encode)
Writes a NULL
-terminated string in the buffer pointed to by buf
with size size
, consisting of the characters in the string list
. The characters are written using encoding encode
.
Returns one of the following:
- The number of bytes written (including terminating
NULL
character) -
-size
if the string was truncated because of buffer space -
0
if list
is not a string that can be encoded with encode
or if size
was < 1
.
The written string is always NULL
-terminated, unless buffer size
is < 1
.
int enif_get_tuple(ErlNifEnv* env, ERL_NIF_TERM term, int* arity, const ERL_NIF_TERM** array)
If term
is a tuple, this function sets *array
to point to an array containing the elements of the tuple, and sets *arity
to the number of elements. Notice that the array is read-only and (*array)[N-1]
is the Nth element of the tuple. *array
is undefined if the arity of the tuple is zero.
Returns true
on success, or false
if term
is not a tuple.
int enif_get_uint(ErlNifEnv* env, ERL_NIF_TERM term, unsigned int* ip)
Sets *ip
to the unsigned integer value of term
.
Returns true
on success, or false
if term
is not an unsigned integer or is outside the bounds of type unsigned int
.
int enif_get_uint64(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifUInt64* ip)
Sets *ip
to the unsigned integer value of term
.
Returns true
on success, or false
if term
is not an unsigned integer or is outside the bounds of an unsigned 64-bit integer.
int enif_get_ulong(ErlNifEnv* env, ERL_NIF_TERM term, unsigned long* ip)
Sets *ip
to the unsigned long integer value of term
.
Returns true
on success, or false
if term
is not an unsigned integer or is outside the bounds of type unsigned long
.
int enif_getenv(const char* key, char* value, size_t *value_size)
Same as erl_drv_getenv
.
int enif_has_pending_exception(ErlNifEnv* env, ERL_NIF_TERM* reason)
Returns true
if a pending exception is associated with the environment env
. If reason
is a NULL
pointer, ignore it. Otherwise, if a pending exception associated with env
exists, set *reason
to the value of the exception term. For example, if enif_make_badarg
is called to set a pending badarg
exception, a later call to enif_has_pending_exception(env, &reason)
sets *reason
to the atom badarg
, then return true
.
See also enif_make_badarg
and enif_raise_exception
.
ErlNifUInt64 enif_hash(ErlNifHash type, ERL_NIF_TERM term, ErlNifUInt64 salt)
Hashes term
according to the specified ErlNifHash
type
.
Ranges of taken salt (if any) and returned value depend on the hash type.
int enif_inspect_binary(ErlNifEnv* env, ERL_NIF_TERM bin_term, ErlNifBinary* bin)
Initializes the structure pointed to by bin
with information about binary term bin_term
.
Returns true
on success, or false
if bin_term
is not a binary.
int enif_inspect_iolist_as_binary(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifBinary* bin)
Initializes the structure pointed to by bin
with a continuous buffer with the same byte content as iolist
. As with inspect_binary
, the data pointed to by bin
is transient and does not need to be released.
Returns true
on success, or false
if iolist
is not an iolist.
int enif_inspect_iovec(ErlNifEnv* env, size_t max_elements, ERL_NIF_TERM iovec_term, ERL_NIF_TERM* tail, ErlNifIOVec** iovec)
Fills iovec
with the list of binaries provided in iovec_term
. The number of elements handled in the call is limited to max_elements
, and tail
is set to the remainder of the list. Note that the output may be longer than max_elements
on some platforms.
To create a list of binaries from an arbitrary iolist, use erlang:iolist_to_iovec/1
.
When calling this function, iovec
should contain a pointer to NULL
or a ErlNifIOVec structure that should be used if possible. e.g.
/* Don't use a pre-allocated structure */
ErlNifIOVec *iovec = NULL;
enif_inspect_iovec(env, max_elements, term, &tail, &iovec);
/* Use a stack-allocated vector as an optimization for vectors with few elements */
ErlNifIOVec vec, *iovec = &vec;
enif_inspect_iovec(env, max_elements, term, &tail, &iovec);
The contents of the iovec
is valid until the called nif function returns. If the iovec
should be valid after the nif call returns, it is possible to call this function with a NULL
environment. If no environment is given the iovec
owns the data in the vector and it has to be explicitly freed using enif_free_iovec
.
Returns true
on success, or false
if iovec_term
not an iovec.
ErlNifIOQueue *enif_ioq_create(ErlNifIOQueueOpts opts)
Create a new I/O Queue that can be used to store data. opts
has to be set to ERL_NIF_IOQ_NORMAL
.
void enif_ioq_destroy(ErlNifIOQueue *q)
Destroy the I/O queue and free all of it's contents
int enif_ioq_deq(ErlNifIOQueue *q, size_t count, size_t *size)
Dequeue count
bytes from the I/O queue. If size
is not NULL
, the new size of the queue is placed there.
Returns true
on success, or false
if the I/O does not contain count
bytes. On failure the queue is left un-altered.
int enif_ioq_enq_binary(ErlNifIOQueue *q, ErlNifBinary *bin, size_t skip)
Enqueue the bin
into q
skipping the first skip
bytes.
Returns true
on success, or false
if skip
is greater than the size of bin
. Any ownership of the binary data is transferred to the queue and bin
is to be considered read-only for the rest of the NIF call and then as released.
int enif_ioq_enqv(ErlNifIOQueue *q, ErlNifIOVec *iovec, size_t skip)
Enqueue the iovec
into q
skipping the first skip
bytes.
Returns true
on success, or false
if skip
is greater than the size of iovec
.
SysIOVec *enif_ioq_peek(ErlNifIOQueue *q, int *iovlen)
Get the I/O queue as a pointer to an array of SysIOVec
s. It also returns the number of elements in iovlen
.
Nothing is removed from the queue by this function, that must be done with enif_ioq_deq
.
The returned array is suitable to use with the Unix system call writev
.
int enif_ioq_peek_head(ErlNifEnv *env, ErlNifIOQueue *q, size_t *size, ERL_NIF_TERM *bin_term)
Get the head of the IO Queue as a binary term.
If size
is not NULL
, the size of the head is placed there.
Nothing is removed from the queue by this function, that must be done with enif_ioq_deq
.
Returns true
on success, or false
if the queue is empty.
size_t enif_ioq_size(ErlNifIOQueue *q)
Get the size of q
.
int enif_is_atom(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is an atom.
int enif_is_binary(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a binary.
int enif_is_current_process_alive(ErlNifEnv* env)
Returns true
if the currently executing process is currently alive, otherwise false
.
This function can only be used from a NIF-calling thread, and with an environment corresponding to currently executing processes.
int enif_is_empty_list(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is an empty list.
int enif_is_exception(ErlNifEnv* env, ERL_NIF_TERM term)
Return true if term
is an exception.
int enif_is_fun(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a fun.
int enif_is_identical(ERL_NIF_TERM lhs, ERL_NIF_TERM rhs)
Returns true
if the two terms are identical. Corresponds to the Erlang operators =:=
and =/=
.
int enif_is_list(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a list.
int enif_is_map(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a map, otherwise false
.
int enif_is_number(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a number.
int enif_is_pid(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a pid.
int enif_is_port(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a port.
int enif_is_port_alive(ErlNifEnv* env, ErlNifPort *port_id)
Returns true
if port_id
is alive.
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.
int enif_is_process_alive(ErlNifEnv* env, ErlNifPid *pid)
Returns true
if pid
is alive.
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.
int enif_is_ref(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a reference.
int enif_is_tuple(ErlNifEnv* env, ERL_NIF_TERM term)
Returns true
if term
is a tuple.
int enif_keep_resource(void* obj)
Adds a reference to resource object obj
obtained from enif_alloc_resource
. Each call to enif_keep_resource
for an object must be balanced by a call to enif_release_resource
before the object is destructed.
ERL_NIF_TERM enif_make_atom(ErlNifEnv* env, const char* name)
Creates an atom term from the NULL
-terminated C-string name
with ISO Latin-1 encoding. If the length of name
exceeds the maximum length allowed for an atom (255 characters), enif_make_atom
invokes enif_make_badarg
.
ERL_NIF_TERM enif_make_atom_len(ErlNifEnv* env, const char* name, size_t len)
Create an atom term from the string name
with length len
. NULL
characters are treated as any other characters. If len
exceeds the maximum length allowed for an atom (255 characters), enif_make_atom
invokes enif_make_badarg
.
ERL_NIF_TERM enif_make_badarg(ErlNifEnv* env)
Makes a badarg
exception to be returned from a NIF, and associates it with environment env
. Once a NIF or any function it calls invokes enif_make_badarg
, the runtime ensures that a badarg
exception is raised when the NIF returns, even if the NIF attempts to return a non-exception term instead.
The return value from enif_make_badarg
can be used only as the return value from the NIF that invoked it (directly or indirectly) or be passed to enif_is_exception
, but not to any other NIF API function.
See also enif_has_pending_exception
and enif_raise_exception
.
Note
Before ERTS 7.0 (Erlang/OTP 18), the return value from enif_make_badarg
had to be returned from the NIF. This requirement is now lifted as the return value from the NIF is ignored if enif_make_badarg
has been invoked.
ERL_NIF_TERM enif_make_binary(ErlNifEnv* env, ErlNifBinary* bin)
Makes a binary term from bin
. Any ownership of the binary data is transferred to the created term and bin
is to be considered read-only for the rest of the NIF call and then as released.
ERL_NIF_TERM enif_make_copy(ErlNifEnv* dst_env, ERL_NIF_TERM src_term)
Makes a copy of term src_term
. The copy is created in environment dst_env
. The source term can be located in any environment.
ERL_NIF_TERM enif_make_double(ErlNifEnv* env, double d)
Creates a floating-point term from a double
. If argument double
is not finite or is NaN, enif_make_double
invokes enif_make_badarg
.
int enif_make_existing_atom(ErlNifEnv* env, const char* name, ERL_NIF_TERM* atom, ErlNifCharEncoding encode)
Tries to create the term of an already existing atom from the NULL
-terminated C-string name
with encoding encode
.
If the atom already exists, this function stores the term in *atom
and returns true
, otherwise false
. Also returns false
if the length of name
exceeds the maximum length allowed for an atom (255 characters).
int enif_make_existing_atom_len(ErlNifEnv* env, const char* name, size_t len, ERL_NIF_TERM* atom, ErlNifCharEncoding encoding)
Tries to create the term of an already existing atom from the string name
with length len
and encoding encode
. NULL
characters are treated as any other characters.
If the atom already exists, this function stores the term in *atom
and returns true
, otherwise false
. Also returns false
if len
exceeds the maximum length allowed for an atom (255 characters).
ERL_NIF_TERM enif_make_int(ErlNifEnv* env, int i)
Creates an integer term.
ERL_NIF_TERM enif_make_int64(ErlNifEnv* env, ErlNifSInt64 i)
Creates an integer term from a signed 64-bit integer.
ERL_NIF_TERM enif_make_list(ErlNifEnv* env, unsigned cnt, ...)
Creates an ordinary list term of length cnt
. Expects cnt
number of arguments (after cnt
) of type ERL_NIF_TERM
as the elements of the list.
Returns an empty list if cnt
is 0.
ERL_NIF_TERM enif_make_list1(ErlNifEnv* env, ERL_NIF_TERM e1)
ERL_NIF_TERM enif_make_list2(ErlNifEnv* env, ERL_NIF_TERM e1, ERL_NIF_TERM e2)
ERL_NIF_TERM enif_make_list3(ErlNifEnv* env, ERL_NIF_TERM e1, ERL_NIF_TERM e2, ERL_NIF_TERM e3)
ERL_NIF_TERM enif_make_list4(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e4)
ERL_NIF_TERM enif_make_list5(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e5)
ERL_NIF_TERM enif_make_list6(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e6)
ERL_NIF_TERM enif_make_list7(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e7)
ERL_NIF_TERM enif_make_list8(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e8)
ERL_NIF_TERM enif_make_list9(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e9)
Creates an ordinary list term with length indicated by the function name. Prefer these functions (macros) over the variadic enif_make_list
to get a compile-time error if the number of arguments does not match.
ERL_NIF_TERM enif_make_list_cell(ErlNifEnv* env, ERL_NIF_TERM head, ERL_NIF_TERM tail)
Creates a list cell [head | tail]
.
ERL_NIF_TERM enif_make_list_from_array(ErlNifEnv* env, const ERL_NIF_TERM arr[], unsigned cnt)
Creates an ordinary list containing the elements of array arr
of length cnt
.
Returns an empty list if cnt
is 0.
ERL_NIF_TERM enif_make_long(ErlNifEnv* env, long int i)
Creates an integer term from a long int
.
int enif_make_map_put(ErlNifEnv* env, ERL_NIF_TERM map_in, ERL_NIF_TERM key, ERL_NIF_TERM value, ERL_NIF_TERM* map_out)
Makes a copy of map map_in
and inserts key
with value
. If key
already exists in map_in
, the old associated value is replaced by value
.
If successful, this function sets *map_out
to the new map and returns true
. Returns false
if map_in
is not a map.
The map_in
term must belong to environment env
.
int enif_make_map_remove(ErlNifEnv* env, ERL_NIF_TERM map_in, ERL_NIF_TERM key, ERL_NIF_TERM* map_out)
If map map_in
contains key
, this function makes a copy of map_in
in *map_out
, and removes key
and the associated value. If map map_in
does not contain key
, *map_out
is set to map_in
.
Returns true
on success, or false
if map_in
is not a map.
The map_in
term must belong to environment env
.
int enif_make_map_update(ErlNifEnv* env, ERL_NIF_TERM map_in, ERL_NIF_TERM key, ERL_NIF_TERM new_value, ERL_NIF_TERM* map_out)
Makes a copy of map map_in
and replace the old associated value for key
with new_value
.
If successful, this function sets *map_out
to the new map and returns true
. Returns false
if map_in
is not a map or if it does not contain key
.
The map_in
term must belong to environment env
.
int enif_make_map_from_arrays(ErlNifEnv* env, ERL_NIF_TERM keys[], ERL_NIF_TERM values[], size_t cnt, ERL_NIF_TERM *map_out)
Makes a map term from the given keys and values.
If successful, this function sets *map_out
to the new map and returns true
. Returns false
there are any duplicate keys.
All keys and values must belong to env
.
unsigned char *enif_make_new_binary(ErlNifEnv* env, size_t size, ERL_NIF_TERM* termp)
Allocates a binary of size size
bytes and creates an owning term. The binary data is mutable until the calling NIF returns. This is a quick way to create a new binary without having to use ErlNifBinary
. The drawbacks are that the binary cannot be kept between NIF calls and it cannot be reallocated.
Returns a pointer to the raw binary data and sets *termp
to the binary term.
ERL_NIF_TERM enif_make_new_map(ErlNifEnv* env)
Makes an empty map term.
ERL_NIF_TERM enif_make_pid(ErlNifEnv* env, const ErlNifPid* pid)
Makes a pid term from *pid
.
ERL_NIF_TERM enif_make_ref(ErlNifEnv* env)
Creates a reference like erlang:make_ref/0
.
ERL_NIF_TERM enif_make_resource(ErlNifEnv* env, void* obj)
Creates an opaque handle to a memory-managed resource object obtained by enif_alloc_resource
. No ownership transfer is done, as the resource object still needs to be released by enif_release_resource
. However, notice that the call to enif_release_resource
can occur immediately after obtaining the term from enif_make_resource
, in which case the resource object is deallocated when the term is garbage collected. For more details, see the example of creating and returning a resource object
in the User's Guide.
Note
Since ERTS 9.0 (OTP-20.0), resource terms have a defined behavior when compared and serialized through term_to_binary
or passed between nodes.
-
Two resource terms will compare equal iff they would yield the same resource object pointer when passed to enif_get_resource
.
-
A resource term can be serialized with term_to_binary
and later be fully recreated if the resource object is still alive when binary_to_term
is called. A stale resource term will be returned from binary_to_term
if the resource object has been deallocated. enif_get_resource
will return false for stale resource terms.
The same principles of serialization apply when passing resource terms in messages to remote nodes and back again. A resource term will act stale on all nodes except the node where its resource object is still alive in memory.
Before ERTS 9.0 (OTP-20.0), all resource terms did compare equal to each other and to empty binaries (<<>>
). If serialized, they would be recreated as plain empty binaries.
ERL_NIF_TERM enif_make_resource_binary(ErlNifEnv* env, void* obj, const void* data, size_t size)
Creates a binary term that is memory-managed by a resource object obj
obtained by enif_alloc_resource
. The returned binary term consists of size
bytes pointed to by data
. This raw binary data must be kept readable and unchanged until the destructor of the resource is called. The binary data can be stored external to the resource object, in which case the destructor is responsible for releasing the data.
Several binary terms can be managed by the same resource object. The destructor is not called until the last binary is garbage collected. This can be useful to return different parts of a larger binary buffer.
As with enif_make_resource
, no ownership transfer is done. The resource still needs to be released with enif_release_resource
.
int enif_make_reverse_list(ErlNifEnv* env, ERL_NIF_TERM list_in, ERL_NIF_TERM *list_out)
Sets *list_out
to the reverse list of the list list_in
and returns true
, or returns false
if list_in
is not a list.
This function is only to be used on short lists, as a copy is created of the list, which is not released until after the NIF returns.
The list_in
term must belong to environment env
.
ERL_NIF_TERM enif_make_string(ErlNifEnv* env, const char* string, ErlNifCharEncoding encoding)
Creates a list containing the characters of the NULL
-terminated string string
with encoding encoding
.
ERL_NIF_TERM enif_make_string_len(ErlNifEnv* env, const char* string, size_t len, ErlNifCharEncoding encoding)
Creates a list containing the characters of the string string
with length len
and encoding encoding
. NULL
characters are treated as any other characters.
ERL_NIF_TERM enif_make_sub_binary(ErlNifEnv* env, ERL_NIF_TERM bin_term, size_t pos, size_t size)
Makes a subbinary of binary bin_term
, starting at zero-based position pos
with a length of size
bytes. bin_term
must be a binary or bitstring. pos+size
must be less or equal to the number of whole bytes in bin_term
.
ERL_NIF_TERM enif_make_tuple(ErlNifEnv* env, unsigned cnt, ...)
Creates a tuple term of arity cnt
. Expects cnt
number of arguments (after cnt
) of type ERL_NIF_TERM
as the elements of the tuple.
ERL_NIF_TERM enif_make_tuple1(ErlNifEnv* env, ERL_NIF_TERM e1)
ERL_NIF_TERM enif_make_tuple2(ErlNifEnv* env, ERL_NIF_TERM e1, ERL_NIF_TERM e2)
ERL_NIF_TERM enif_make_tuple3(ErlNifEnv* env, ERL_NIF_TERM e1, ERL_NIF_TERM e2, ERL_NIF_TERM e3)
ERL_NIF_TERM enif_make_tuple4(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e4)
ERL_NIF_TERM enif_make_tuple5(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e5)
ERL_NIF_TERM enif_make_tuple6(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e6)
ERL_NIF_TERM enif_make_tuple7(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e7)
ERL_NIF_TERM enif_make_tuple8(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e8)
ERL_NIF_TERM enif_make_tuple9(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e9)
Creates a tuple term with length indicated by the function name. Prefer these functions (macros) over the variadic enif_make_tuple
to get a compile-time error if the number of arguments does not match.
ERL_NIF_TERM enif_make_tuple_from_array(ErlNifEnv* env, const ERL_NIF_TERM arr[], unsigned cnt)
Creates a tuple containing the elements of array arr
of length cnt
.
ERL_NIF_TERM enif_make_uint(ErlNifEnv* env, unsigned int i)
Creates an integer term from an unsigned int
.
ERL_NIF_TERM enif_make_uint64(ErlNifEnv* env, ErlNifUInt64 i)
Creates an integer term from an unsigned 64-bit integer.
ERL_NIF_TERM enif_make_ulong(ErlNifEnv* env, unsigned long i)
Creates an integer term from an unsigned long int
.
ERL_NIF_TERM enif_make_unique_integer(ErlNifEnv *env, ErlNifUniqueInteger properties)
Returns a unique integer with the same properties as specified by erlang:unique_integer/1
.
env
is the environment to create the integer in.
ERL_NIF_UNIQUE_POSITIVE
and ERL_NIF_UNIQUE_MONOTONIC
can be passed as the second argument to change the properties of the integer returned. They can be combined by OR:ing the two values together.
See also ErlNifUniqueInteger
.
int enif_map_iterator_create(ErlNifEnv *env, ERL_NIF_TERM map, ErlNifMapIterator *iter, ErlNifMapIteratorEntry entry)
Creates an iterator for the map map
by initializing the structure pointed to by iter
. Argument entry
determines the start position of the iterator: ERL_NIF_MAP_ITERATOR_FIRST
or ERL_NIF_MAP_ITERATOR_LAST
.
Returns true
on success, or false if map
is not a map.
A map iterator is only useful during the lifetime of environment env
that the map
belongs to. The iterator must be destroyed by calling enif_map_iterator_destroy
:
ERL_NIF_TERM key, value;
ErlNifMapIterator iter;
enif_map_iterator_create(env, my_map, &iter, ERL_NIF_MAP_ITERATOR_FIRST);
while (enif_map_iterator_get_pair(env, &iter, &key, &value)) {
do_something(key,value);
enif_map_iterator_next(env, &iter);
}
enif_map_iterator_destroy(env, &iter);
Note
The key-value pairs of a map have no defined iteration order. The only guarantee is that the iteration order of a single map instance is preserved during the lifetime of the environment that the map belongs to.
void enif_map_iterator_destroy(ErlNifEnv *env, ErlNifMapIterator *iter)
Destroys a map iterator created by enif_map_iterator_create
.
int enif_map_iterator_get_pair(ErlNifEnv *env, ErlNifMapIterator *iter, ERL_NIF_TERM *key, ERL_NIF_TERM *value)
Gets key and value terms at the current map iterator position.
On success, sets *key
and *value
and returns true
. Returns false
if the iterator is positioned at head (before first entry) or tail (beyond last entry).
int enif_map_iterator_is_head(ErlNifEnv *env, ErlNifMapIterator *iter)
Returns true
if map iterator iter
is positioned before the first entry.
int enif_map_iterator_is_tail(ErlNifEnv *env, ErlNifMapIterator *iter)
Returns true
if map iterator iter
is positioned after the last entry.
int enif_map_iterator_next(ErlNifEnv *env, ErlNifMapIterator *iter)
Increments map iterator to point to the next key-value entry.
Returns true
if the iterator is now positioned at a valid key-value entry, or false
if the iterator is positioned at the tail (beyond the last entry).
int enif_map_iterator_prev(ErlNifEnv *env, ErlNifMapIterator *iter)
Decrements map iterator to point to the previous key-value entry.
Returns true
if the iterator is now positioned at a valid key-value entry, or false
if the iterator is positioned at the head (before the first entry).
int enif_monitor_process(ErlNifEnv* env, void* obj, const ErlNifPid* target_pid, ErlNifMonitor* mon)
Starts monitoring a process from a resource. When a process is monitored, a process exit results in a call to the provided down
callback associated with the resource type.
Argument obj
is pointer to the resource to hold the monitor and *target_pid
identifies the local process to be monitored.
If mon
is not NULL
, a successful call stores the identity of the monitor in the ErlNifMonitor
struct pointed to by mon
. This identifier is used to refer to the monitor for later removal with enif_demonitor_process
or compare with enif_compare_monitors
. A monitor is automatically removed when it triggers or when the resource is deallocated.
Returns 0
on success, < 0 if no down
callback is provided, and > 0 if the process is no longer alive.
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.
ErlNifTime enif_monotonic_time(ErlNifTimeUnit time_unit)
Returns the current Erlang monotonic time
. Notice that it is not uncommon with negative values.
time_unit
is the time unit of the returned value.
Returns ERL_NIF_TIME_ERROR
if called with an invalid time unit argument, or if called from a thread that is not a scheduler thread.
See also ErlNifTime
and ErlNifTimeUnit
.
ErlNifMutex *enif_mutex_create(char *name)
Same as erl_drv_mutex_create
.
void enif_mutex_destroy(ErlNifMutex *mtx)
Same as erl_drv_mutex_destroy
.
void enif_mutex_lock(ErlNifMutex *mtx)
Same as erl_drv_mutex_lock
.
char*enif_mutex_name(ErlNifMutex* mtx)
Same as erl_drv_mutex_name
.
int enif_mutex_trylock(ErlNifMutex *mtx)
Same as erl_drv_mutex_trylock
.
void enif_mutex_unlock(ErlNifMutex *mtx)
Same as erl_drv_mutex_unlock
.
ERL_NIF_TERM enif_now_time(ErlNifEnv *env)
Returns an erlang:now()
time stamp.
This function is deprecated.
ErlNifResourceType *enif_open_resource_type(ErlNifEnv* env, const char* module_str, const char* name, ErlNifResourceDtor* dtor, ErlNifResourceFlags flags, ErlNifResourceFlags* tried)
Creates or takes over a resource type identified by the string name
and gives it the destructor function pointed to by dtor
. Argument flags
can have the following values:
ERL_NIF_RT_CREATE
- Creates a new resource type that does not already exist.
ERL_NIF_RT_TAKEOVER
- Opens an existing resource type and takes over ownership of all its instances. The supplied destructor
dtor
is called both for existing instances and new instances not yet created by the calling NIF library.
The two flag values can be combined with bitwise OR. The resource type name is local to the calling module. Argument module_str
is not (yet) used and must be NULL
. dtor
can be NULL
if no destructor is needed.
On success, the function returns a pointer to the resource type and *tried
is set to either ERL_NIF_RT_CREATE
or ERL_NIF_RT_TAKEOVER
to indicate what was done. On failure, returns NULL
and sets *tried
to flags
. It is allowed to set tried
to NULL
.
Notice that enif_open_resource_type
is only allowed to be called in the two callbacks load
and upgrade
.
See also enif_open_resource_type_x
.
ErlNifResourceType *enif_open_resource_type_x(ErlNifEnv* env, const char* name, const ErlNifResourceTypeInit* init, ErlNifResourceFlags flags, ErlNifResourceFlags* tried)
Same as enif_open_resource_type
except it accepts additional callback functions for resource types that are used together with enif_select
and enif_monitor_process
.
Argument init
is a pointer to an ErlNifResourceTypeInit
structure that contains the function pointers for destructor, down and stop callbacks for the resource type.
int enif_port_command(ErlNifEnv* env, const ErlNifPort* to_port, ErlNifEnv *msg_env, ERL_NIF_TERM msg)
Works as erlang:port_command/2
, except that it is always completely asynchronous.
env
- The environment of the calling process. Must not be
NULL
. *to_port
- The port ID of the receiving port. The port ID is to refer to a port on the local node.
msg_env
- The environment of the message term. Can be a process-independent environment allocated with
enif_alloc_env
or NULL
. msg
- The message term to send. The same limitations apply as on the payload to
erlang:port_command/2
.
Using a msg_env
of NULL
is an optimization, which groups together calls to enif_alloc_env
, enif_make_copy
, enif_port_command
, and enif_free_env
into one call. This optimization is only useful when a majority of the terms are to be copied from env
to msg_env
.
Returns true
if the command is successfully sent. Returns false
if the command fails, for example:
-
*to_port
does not refer to a local port. - The currently executing process (that is, the sender) is not alive.
-
msg
is invalid.
See also enif_get_local_port
.
void *enif_priv_data(ErlNifEnv* env)
Returns the pointer to the private data that was set by load
or upgrade
.
ERL_NIF_TERM enif_raise_exception(ErlNifEnv* env, ERL_NIF_TERM reason)
Creates an error exception with the term reason
to be returned from a NIF, and associates it with environment env
. Once a NIF or any function it calls invokes enif_raise_exception
, the runtime ensures that the exception it creates is raised when the NIF returns, even if the NIF attempts to return a non-exception term instead.
The return value from enif_raise_exception
can only be used as the return value from the NIF that invoked it (directly or indirectly) or be passed to enif_is_exception
, but not to any other NIF API function.
See also enif_has_pending_exception
and enif_make_badarg
.
void *enif_realloc(void* ptr, size_t size)
Reallocates memory allocated by enif_alloc
to size
bytes.
Returns NULL
if the reallocation fails.
The returned pointer is suitably aligned for any built-in type that fit in the allocated memory.
int enif_realloc_binary(ErlNifBinary* bin, size_t size)
Changes the size of a binary bin
. The source binary can be read-only, in which case it is left untouched and a mutable copy is allocated and assigned to *bin
.
Returns true
on success, or false
if memory allocation failed.
void enif_release_binary(ErlNifBinary* bin)
Releases a binary obtained from enif_alloc_binary
.
void enif_release_resource(void* obj)
Removes a reference to resource object obj
obtained from enif_alloc_resource
. The resource object is destructed when the last reference is removed. Each call to enif_release_resource
must correspond to a previous call to enif_alloc_resource
or enif_keep_resource
. References made by enif_make_resource
can only be removed by the garbage collector.
ErlNifRWLock *enif_rwlock_create(char *name)
Same as erl_drv_rwlock_create
.
void enif_rwlock_destroy(ErlNifRWLock *rwlck)
Same as erl_drv_rwlock_destroy
.
char*enif_rwlock_name(ErlNifRWLock* rwlck)
Same as erl_drv_rwlock_name
.
void enif_rwlock_rlock(ErlNifRWLock *rwlck)
Same as erl_drv_rwlock_rlock
.
void enif_rwlock_runlock(ErlNifRWLock *rwlck)
Same as erl_drv_rwlock_runlock
.
void enif_rwlock_rwlock(ErlNifRWLock *rwlck)
Same as erl_drv_rwlock_rwlock
.
void enif_rwlock_rwunlock(ErlNifRWLock *rwlck)
Same as erl_drv_rwlock_rwunlock
.
int enif_rwlock_tryrlock(ErlNifRWLock *rwlck)
Same as erl_drv_rwlock_tryrlock
.
int enif_rwlock_tryrwlock(ErlNifRWLock *rwlck)
Same as erl_drv_rwlock_tryrwlock
.
ERL_NIF_TERM enif_schedule_nif(ErlNifEnv* env, const char* fun_name, int flags, ERL_NIF_TERM (*fp)(ErlNifEnv* env, int argc, const ERL_NIF_TERM argv[]), int argc, const ERL_NIF_TERM argv[])
Schedules NIF fp
to execute. This function allows an application to break up long-running work into multiple regular NIF calls or to schedule a dirty NIF
to execute on a dirty scheduler thread.
fun_name
-
Provides a name for the NIF that is scheduled for execution. If it cannot be converted to an atom, enif_schedule_nif
returns a badarg
exception.
flags
-
Must be set to 0
for a regular NIF. If the emulator was built with dirty scheduler support enabled, flags
can be set to either ERL_NIF_DIRTY_JOB_CPU_BOUND
if the job is expected to be CPU-bound, or ERL_NIF_DIRTY_JOB_IO_BOUND
for jobs that will be I/O-bound. If dirty scheduler threads are not available in the emulator, an attempt to schedule such a job results in a notsup
exception.
argc
and argv
-
Can either be the originals passed into the calling NIF, or can be values created by the calling NIF.
The calling NIF must use the return value of enif_schedule_nif
as its own return value.
Be aware that enif_schedule_nif
, as its name implies, only schedules the NIF for future execution. The calling NIF does not block waiting for the scheduled NIF to execute and return. This means that the calling NIF cannot expect to receive the scheduled NIF return value and use it for further operations.
int enif_select(ErlNifEnv* env, ErlNifEvent event, enum ErlNifSelectFlags mode, void* obj, const ErlNifPid* pid, ERL_NIF_TERM ref)
This function can be used to receive asynchronous notifications when OS-specific event objects become ready for either read or write operations.
Argument event
identifies the event object. On Unix systems, the functions select
/poll
are used. The event object must be a socket, pipe or other file descriptor object that select
/poll
can use.
Argument mode
describes the type of events to wait for. It can be ERL_NIF_SELECT_READ
, ERL_NIF_SELECT_WRITE
or a bitwise OR combination to wait for both. It can also be ERL_NIF_SELECT_STOP
which is described further below. When a read or write event is triggered, a notification message like this is sent to the process identified by pid
:
{select, Obj, Ref, ready_input | ready_output}
ready_input
or ready_output
indicates if the event object is ready for reading or writing.
Argument pid
may be NULL
to indicate the calling process.
Argument obj
is a resource object obtained from enif_alloc_resource
. The purpose of the resource objects is as a container of the event object to manage its state and lifetime. A handle to the resource is received in the notification message as Obj
.
Argument ref
must be either a reference obtained from erlang:make_ref/0
or the atom undefined
. It will be passed as Ref
in the notifications. If a selective receive
statement is used to wait for the notification then a reference created just before the receive
will exploit a runtime optimization that bypasses all earlier received messages in the queue.
The notifications are one-shot only. To receive further notifications of the same type (read or write), repeated calls to enif_select
must be made after receiving each notification.
Use ERL_NIF_SELECT_STOP
as mode
in order to safely close an event object that has been passed to enif_select
. The stop
callback of the resource obj
will be called when it is safe to close the event object. This safe way of closing event objects must be used even if all notifications have been received and no further calls to enif_select
have been made.
The first call to enif_select
for a specific OS event
will establish a relation between the event object and the containing resource. All subsequent calls for an event
must pass its containing resource as argument obj
. The relation is dissolved when enif_select
has been called with mode
as ERL_NIF_SELECT_STOP
and the corresponding stop
callback has returned. A resource can contain several event objects but one event object can only be contained within one resource. A resource will not be destructed until all its contained relations have been dissolved.
Note
Use enif_monitor_process
together with enif_select
to detect failing Erlang processes and prevent them from causing permanent leakage of resources and their contained OS event objects.
Returns a non-negative value on success where the following bits can be set:
ERL_NIF_SELECT_STOP_CALLED
- The stop callback was called directly by
enif_select
. ERL_NIF_SELECT_STOP_SCHEDULED
- The stop callback was scheduled to run on some other thread or later by this thread.
Returns a negative value if the call failed where the following bits can be set:
ERL_NIF_SELECT_INVALID_EVENT
- Argument
event
is not a valid OS event object. ERL_NIF_SELECT_FAILED
- The system call failed to add the event object to the poll set.
Note
Use bitwise AND to test for specific bits in the return value. New significant bits may be added in future releases to give more detailed information for both failed and successful calls. Do NOT use equality tests like ==
, as that may cause your application to stop working.
Example:
retval = enif_select(env, fd, ERL_NIF_SELECT_STOP, resource, ref);
if (retval < 0) {
/* handle error */
}
/* Success! */
if (retval & ERL_NIF_SELECT_STOP_CALLED) {
/* ... */
}
ErlNifPid *enif_self(ErlNifEnv* caller_env, ErlNifPid* pid)
Initializes the ErlNifPid
variable at *pid
to represent the calling process.
Returns pid
if successful, or NULL if caller_env
is not a process-bound environment
.
int enif_send(ErlNifEnv* env, ErlNifPid* to_pid, ErlNifEnv* msg_env, ERL_NIF_TERM msg)
Sends a message to a process.
env
- The environment of the calling process. Must be
NULL
only if calling from a created thread. *to_pid
- The pid of the receiving process. The pid is to refer to a process on the local node.
msg_env
- The environment of the message term. Must be a process-independent environment allocated with
enif_alloc_env
or NULL. msg
- The message term to send.
Returns true
if the message is successfully sent. Returns false
if the send operation fails, that is:
-
*to_pid
does not refer to an alive local process. - The currently executing process (that is, the sender) is not alive.
The message environment msg_env
with all its terms (including msg
) is invalidated by a successful call to enif_send
. The environment is to either be freed with enif_free_env
of cleared for reuse with enif_clear_env
.
If msg_env
is set to NULL
, the msg
term is copied and the original term and its environment is still valid after the call.
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.
Note
Passing msg_env
as NULL
is only supported as from ERTS 8.0 (Erlang/OTP 19).
unsigned enif_sizeof_resource(void* obj)
Gets the byte size of resource object obj
obtained by enif_alloc_resource
.
int enif_snprintf(char *str, size_t size, const char *format, ...)
Similar to snprintf
but this format string also accepts "%T"
, which formats Erlang terms.
This function was originally intenden for debugging purpose. It is not recommended to print very large terms with %T
. The function may change errno
, even if successful.
void enif_system_info(ErlNifSysInfo *sys_info_ptr, size_t size)
Same as driver_system_info
.
int enif_term_to_binary(ErlNifEnv *env, ERL_NIF_TERM term, ErlNifBinary *bin)
Allocates a new binary with enif_alloc_binary
and stores the result of encoding term
according to the Erlang external term format.
Returns true
on success, or false
if the allocation fails.
See also erlang:term_to_binary/1
and enif_binary_to_term
.
int enif_thread_create(char *name,ErlNifTid *tid,void * (*func)(void *),void *args,ErlNifThreadOpts *opts)
Same as erl_drv_thread_create
.
void enif_thread_exit(void *resp)
Same as erl_drv_thread_exit
.
int enif_thread_join(ErlNifTid, void **respp)
Same as erl_drv_thread_join
.
char*enif_thread_name(ErlNifTid tid)
Same as erl_drv_thread_name
.
ErlNifThreadOpts *enif_thread_opts_create(char *name)
Same as erl_drv_thread_opts_create
.
void enif_thread_opts_destroy(ErlNifThreadOpts *opts)
Same as erl_drv_thread_opts_destroy
.
ErlNifTid enif_thread_self(void)
Same as erl_drv_thread_self
.
int enif_thread_type(void)
Determine the type of currently executing thread. A positive value indicates a scheduler thread while a negative value or zero indicates another type of thread. Currently the following specific types exist (which may be extended in the future):
ERL_NIF_THR_UNDEFINED
Undefined thread that is not a scheduler thread.
ERL_NIF_THR_NORMAL_SCHEDULER
A normal scheduler thread.
ERL_NIF_THR_DIRTY_CPU_SCHEDULER
A dirty CPU scheduler thread.
ERL_NIF_THR_DIRTY_IO_SCHEDULER
A dirty I/O scheduler thread.
ErlNifTime enif_time_offset(ErlNifTimeUnit time_unit)
Returns the current time offset between Erlang monotonic time
and Erlang system time
converted into the time_unit
passed as argument.
time_unit
is the time unit of the returned value.
Returns ERL_NIF_TIME_ERROR
if called with an invalid time unit argument or if called from a thread that is not a scheduler thread.
See also ErlNifTime
and ErlNifTimeUnit
.
void *enif_tsd_get(ErlNifTSDKey key)
Same as erl_drv_tsd_get
.
int enif_tsd_key_create(char *name, ErlNifTSDKey *key)
Same as erl_drv_tsd_key_create
.
void enif_tsd_key_destroy(ErlNifTSDKey key)
Same as erl_drv_tsd_key_destroy
.
void enif_tsd_set(ErlNifTSDKey key, void *data)
Same as erl_drv_tsd_set
.
int enif_vfprintf(FILE *stream, const char *format, va_list ap)
Equivalent to enif_fprintf
except that its called with a va_list
instead of a variable number of arguments.
int enif_vsnprintf(char *str, size_t size, const char *format, va_list ap)
Equivalent to enif_snprintf
except that its called with a va_list
instead of a variable number of arguments.
int enif_whereis_pid(ErlNifEnv *env, ERL_NIF_TERM name, ErlNifPid *pid)
Looks up a process by its registered name.
env
- The environment of the calling process. Must be
NULL
only if calling from a created thread. name
- The name of a registered process, as an atom.
*pid
- The
ErlNifPid
in which the resolved process id is stored.
On success, sets *pid
to the local process registered with name
and returns true
. If name
is not a registered process, or is not an atom, false
is returned and *pid
is unchanged.
Works as erlang:whereis/1
, but restricted to processes. See enif_whereis_port
to resolve registered ports.
int enif_whereis_port(ErlNifEnv *env, ERL_NIF_TERM name, ErlNifPort *port)
Looks up a port by its registered name.
env
- The environment of the calling process. Must be
NULL
only if calling from a created thread. name
- The name of a registered port, as an atom.
*port
- The
ErlNifPort
in which the resolved port id is stored.
On success, sets *port
to the port registered with name
and returns true
. If name
is not a registered port, or is not an atom, false
is returned and *port
is unchanged.
Works as erlang:whereis/1
, but restricted to ports. See enif_whereis_pid
to resolve registered processes.