From 5f5fb466630db9dc8e17895c90ed74105852e827 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Fri, 21 Oct 2016 15:44:49 +0200 Subject: erl_interface: Remove CDATA tag except for example code --- lib/erl_interface/doc/src/ei.xml | 280 +++++++++---------- lib/erl_interface/doc/src/ei_connect.xml | 334 +++++++++++------------ lib/erl_interface/doc/src/ei_users_guide.xml | 152 +++++------ lib/erl_interface/doc/src/erl_call.xml | 76 +++--- lib/erl_interface/doc/src/erl_connect.xml | 332 +++++++++++------------ lib/erl_interface/doc/src/erl_error.xml | 32 +-- lib/erl_interface/doc/src/erl_eterm.xml | 392 +++++++++++++-------------- lib/erl_interface/doc/src/erl_format.xml | 38 +-- lib/erl_interface/doc/src/erl_global.xml | 42 +-- lib/erl_interface/doc/src/erl_interface.xml | 198 +++++++------- lib/erl_interface/doc/src/erl_malloc.xml | 36 +-- lib/erl_interface/doc/src/erl_marshal.xml | 66 ++--- lib/erl_interface/doc/src/ref_man_ei.xml | 13 +- lib/erl_interface/doc/src/registry.xml | 244 ++++++++--------- 14 files changed, 1117 insertions(+), 1118 deletions(-) (limited to 'lib/erl_interface/doc') diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 9b01f4af98..ddfb4d88a8 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -35,24 +35,24 @@ ei Routines for handling the Erlang binary term format. -

The library contains macros and functions to encode +

The library ei contains macros and functions to encode and decode the Erlang binary term format.

-

allows you to convert atoms, lists, numbers, and +

ei allows you to convert atoms, lists, numbers, and binaries to and from the binary format. This is useful when - writing port programs and drivers. uses a given + writing port programs and drivers. ei uses a given buffer, no dynamic memory (except - ) and is often quite fast.

+ ei_decode_fun()) and is often quite fast.

-

also handles C-nodes, C-programs that talks Erlang +

ei also handles C-nodes, C-programs that talks Erlang distribution with Erlang nodes (or other C-nodes) using the - Erlang distribution format. The difference between - and is that uses + Erlang distribution format. The difference between ei + and erl_interface is that ei uses the binary format directly when sending and receiving terms. It is also thread safe, and using threads, one process can handle multiple - C-nodes. The library is built on top of - , but of legacy reasons, it does not allow for - multiple C-nodes. In general, is the preferred way + C-nodes. The erl_interface library is built on top of + ei, but of legacy reasons, it does not allow for + multiple C-nodes. In general, ei is the preferred way of doing C-nodes.

The decode and encode functions use a buffer and an index into the @@ -65,37 +65,37 @@

All functions take two parameters:

-

is a pointer to +

buf is a pointer to the buffer where the binary data is or will be.

 -

is a pointer to an index into the +

index is a pointer to an index into the buffer. This parameter is incremented with the size of the term decoded/encoded.

 -

The data is thus at when an - function is called.

+

The data is thus at buf[*index] when an + ei function is called.

-

All encode functions assume that the and - parameters point to a buffer large enough for +

All encode functions assume that the buf and + index parameters point to a buffer large enough for the data. To get the size of an encoded term, without encoding it, - pass instead of a buffer pointer. Parameter - is incremented, but nothing will be encoded. This - is the way in to "preflight" term encoding.

+ pass NULL instead of a buffer pointer. Parameter + index is incremented, but nothing will be encoded. This + is the way in ei to "preflight" term encoding.

There are also encode functions that use a dynamic buffer. It is often more convenient to use these to encode data. All encode functions comes in two versions; those starting with - use a dynamic buffer.

+ ei_x use a dynamic buffer.

-

All functions return if successful, otherwise - (for example, if a term is not of the expected +

All functions return 0 if successful, otherwise + -1 (for example, if a term is not of the expected type, or the data to decode is an invalid Erlang term).

Some of the decode functions need a pre-allocated buffer. This buffer must be allocated large enough, and for non-compound types - the + the ei_get_type() function returns the size required (notice that for strings an extra byte is needed for the NULL-terminator).

 @@ -128,8 +128,8 @@ typedef enum { Decode an atom.

Decodes an atom from the binary format. The NULL-terminated - name of the atom is placed at . At most - bytes can be placed in the buffer.

+ name of the atom is placed at p. At most + MAXATOMLEN bytes can be placed in the buffer.

 @@ -162,7 +162,7 @@ typedef enum { Decode a GMP arbitrary precision integer.

Decodes an integer in the binary format to a GMP - integer. To use this function, the ei + mpz_t integer. To use this function, the ei library must be configured and compiled to use the GMP library.

 @@ -172,10 +172,10 @@ typedef enum { Decode a binary.

Decodes a binary from the binary format. Parameter - is set to the actual size of the - binary. Notice that assumes that + len is set to the actual size of the + binary. Notice that ei_decode_binary() assumes that there is enough room for the binary. The size required can be - fetched by .

+ fetched by ei_get_type().

 @@ -184,8 +184,8 @@ typedef enum { Decode a boolean.

Decodes a boolean value from the binary format. - A boolean is actually an atom, decodes 1 - and decodes 0.

+ A boolean is actually an atom, true decodes 1 + and false decodes 0.

 @@ -195,9 +195,9 @@ typedef enum {

Decodes a char (8-bit) integer between 0-255 from the binary format. For historical reasons the returned integer is of - type . Your C code is to consider the - returned value to be of type even if - the C compilers and system can define to be + type char. Your C code is to consider the + returned value to be of type unsigned char even if + the C compilers and system can define char to be signed.

 @@ -216,16 +216,16 @@ typedef enum { Decode a term, without previous knowledge of type.

Decodes any term, or at least tries to. If the term - pointed at by in fits - in the union, it is decoded, and the - appropriate field in value]]> is set, and - is incremented by the term size.

+ pointed at by *index in buf fits + in the term union, it is decoded, and the + appropriate field in term->value is set, and + *index is incremented by the term size.

The function returns 1 on successful decoding, -1 on error, and 0 if the term seems alright, but does not fit in the - structure. If 1 is returned, the - is incremented, and + term structure. If 1 is returned, the + index is incremented, and term contains the decoded term.

-

The structure contains the arity for a tuple +

The term structure contains the arity for a tuple or list, size for a binary, string, or atom. It contains a term if it is any of the following: integer, float, atom, pid, port, or ref.

@@ -238,11 +238,11 @@ typedef enum { Decode a fun.

Decodes a fun from the binary format. Parameter - is to be NULL or point to an - structure. This is the only decode - function that allocates memory. When the + p is to be NULL or point to an + erlang_fun structure. This is the only decode + function that allocates memory. When the erlang_fun is no longer needed, it is to be freed with - . (This has to do with the arbitrary size + free_fun. (This has to do with the arbitrary size of the environment for a fun.)

 @@ -253,13 +253,13 @@ typedef enum {

Decodes a list header from the binary format. The number of elements is returned in - . The elements + arity. The arity+1 elements follow (the last one is the tail of the list, normally an empty list). - If is , it is an empty + If arity is 0, it is an empty list.

Notice that lists are encoded as strings if they consist entirely of integers in the range 0..255. This function do - not decode such strings, use + not decode such strings, use ei_decode_string() instead.

 @@ -278,8 +278,8 @@ typedef enum { intei_decode_longlong(const char *buf, int *index, long long *p) Decode integer. -

Decodes a GCC or Visual C++ - +

Decodes a GCC long long or Visual C++ + __int64 (64-bit) integer from the binary format. This function is missing in the VxWorks port.

 @@ -300,7 +300,7 @@ typedef enum { intei_decode_pid(const char *buf, int *index, erlang_pid *p) - Decode a . + Decode a pid.

Decodes a process identifier (pid) from the binary format.

 @@ -329,9 +329,9 @@ typedef enum {

Decodes a string from the binary format. A string in Erlang is a list of integers between 0 and 255. Notice that as the string is just a list, sometimes - lists are encoded as strings by , + lists are encoded as strings by term_to_binary/1, even if it was not intended.

-

The string is copied to , and enough space must +

The string is copied to p, and enough space must be allocated. The returned string is NULL-terminated, so you must add an extra byte to the memory requirement.

 @@ -339,11 +339,11 @@ typedef enum { intei_decode_term(const char *buf, int *index, void *t) - Decode a . + Decode a ETERM.

Decodes a term from the binary format. The term - is return in as a , so - is actually an (see + is return in t as a ETERM*, so + t is actually an ETERM** (see erl_eterm). The term is later to be deallocated.

Notice that this function is located in the Erl_Interface @@ -364,7 +364,7 @@ typedef enum { Decode a tuple.

Decodes a tuple header, the number of elements - is returned in . The tuple elements follow + is returned in arity. The tuple elements follow in order in the buffer.

 @@ -383,15 +383,15 @@ typedef enum { intei_decode_ulonglong(const char *buf, int *index, unsigned long long *p) Decode unsigned integer. -

Decodes a GCC or Visual C++ - (64-bit) integer from the binary +

Decodes a GCC unsigned long long or Visual C++ + unsigned __int64 (64-bit) integer from the binary format. This function is missing in the VxWorks port.

 intei_decode_version(const char *buf, int *index, int *version) - Decode an empty list (). + Decode an empty list (nil).

Decodes the version magic number for the Erlang binary term format. It must be the first token in a @@ -406,11 +406,11 @@ typedef enum { intei_x_encode_atom_len(ei_x_buff* x, const char *p, int len) Encode an atom. -

Encodes an atom in the binary format. Parameter +

Encodes an atom in the binary format. Parameter p is the name of the atom in Latin-1 encoding. Only up to MAXATOMLEN-1 bytes are encoded. The name is to be NULL-terminated, except for - the function.

+ the ei_x_encode_atom_len() function.

 @@ -445,7 +445,7 @@ typedef enum { intei_x_encode_bignum(ei_x_buff *x, mpz_t obj) Encode an arbitrary precision integer. -

Encodes a GMP integer to binary format. +

Encodes a GMP mpz_t integer to binary format. To use this function, the ei library must be configured and compiled to use the GMP library.

 @@ -457,7 +457,7 @@ typedef enum { Encode a binary.

Encodes a binary in the binary format. The data is at - , of bytes length.

+ p, of len bytes length.

 @@ -466,8 +466,8 @@ typedef enum { intei_x_encode_boolean(ei_x_buff* x, int p) Encode a boolean. -

Encodes a boolean value as the atom if - p is not zero, or if p is +

Encodes a boolean value as the atom true if + p is not zero, or false if p is zero.

 @@ -479,9 +479,9 @@ typedef enum {

Encodes a char (8-bit) as an integer between 0-255 in the binary format. For historical reasons the integer argument is of - type . Your C code is to consider the specified - argument to be of type even if - the C compilers and system may define to be + type char. Your C code is to consider the specified + argument to be of type unsigned char even if + the C compilers and system may define char to be signed.

 @@ -493,7 +493,7 @@ typedef enum {

Encodes a double-precision (64-bit) floating point number in the binary format.

-

Returns if the floating point +

Returns -1 if the floating point number is not finite.

 @@ -501,7 +501,7 @@ typedef enum { intei_encode_empty_list(char* buf, int* index) intei_x_encode_empty_list(ei_x_buff* x) - Encode an empty list (). + Encode an empty list (nil).

Encodes an empty list. It is often used at the tail of a list.

 @@ -512,10 +512,10 @@ typedef enum { intei_x_encode_fun(ei_x_buff* x, const erlang_fun* fun) Encode a fun. -

Encodes a fun in the binary format. Parameter - points to an structure. The - is not freed automatically, the - is to be called if the fun is not needed +

Encodes a fun in the binary format. Parameter p + points to an erlang_fun structure. The + erlang_fun is not freed automatically, the + free_fun is to be called if the fun is not needed after encoding.

 @@ -526,12 +526,12 @@ typedef enum { Encode a list.

Encodes a list header, with a specified - arity. The next terms are the elements - (actually its cons cells) and the tail of the + arity. The next arity+1 terms are the elements + (actually its arity cons cells) and the tail of the list. Lists and tuples are encoded recursively, so that a list can contain another list or tuple.

For example, to encode the list - :

+ [c, d, [e | f]]:

 ei_encode_list_header(buf, &i, 3);
 ei_encode_atom(buf, &i, "c");
@@ -543,8 +543,8 @@ ei_encode_empty_list(buf, &i);

It may seem that there is no way to create a list without knowing the number of elements in advance. But indeed - there is a way. Notice that the list - can be written as . + there is a way. Notice that the list [a, b, c] + can be written as [a | [b | [c]]]. Using this, a list can be written as conses.

To encode a list, without knowing the arity in advance:

@@ -573,8 +573,8 @@ ei_x_encode_empty_list(&x); intei_x_encode_longlong(ei_x_buff* x, long long p) Encode integer. -

Encodes a GCC or Visual C++ - (64-bit) integer in the binary format. +

Encodes a GCC long long or Visual C++ + __int64 (64-bit) integer in the binary format. This function is missing in the VxWorks port.

 @@ -606,9 +606,9 @@ ei_x_encode_string(&x, "Banana"); Encode a pid.

Encodes an Erlang process identifier (pid) in the binary - format. Parameter points to an - structure (which should have been - obtained earlier with ).

+ format. Parameter p points to an + erlang_pid structure (which should have been + obtained earlier with ei_decode_pid()).

 @@ -618,9 +618,9 @@ ei_x_encode_string(&x, "Banana"); Encode a port.

Encodes an Erlang port in the binary format. Parameter - points to a + p points to a erlang_port structure (which should have been obtained earlier with - ).

+ ei_decode_port()).

 @@ -630,9 +630,9 @@ ei_x_encode_string(&x, "Banana"); Encode a ref.

Encodes an Erlang reference in the binary format. Parameter - points to a + p points to a erlang_ref structure (which should have been obtained earlier with - ).

+ ei_decode_ref()).

 @@ -646,19 +646,19 @@ ei_x_encode_string(&x, "Banana");

Encodes a string in the binary format. (A string in Erlang is a list, but is encoded as a character array in the binary format.) The string is to be NULL-terminated, except for - the function.

+ the ei_x_encode_string_len() function.

 intei_encode_term(char *buf, int *index, void *t) intei_x_encode_term(ei_x_buff* x, void *t) - Encode an term. + Encode an erl_interface term. -

Encodes an , as obtained from - . Parameter is - actually an pointer. This function - does not free the .

+

Encodes an ETERM, as obtained from + erl_interface. Parameter t is + actually an ETERM pointer. This function + does not free the ETERM.

 @@ -667,9 +667,9 @@ ei_x_encode_string(&x, "Banana"); Encode a trace token.

Encodes an Erlang trace token in the binary format. - Parameter points to a - structure (which should have been - obtained earlier with ).

+ Parameter p points to a + erlang_trace structure (which should have been + obtained earlier with ei_decode_trace()).

 @@ -679,10 +679,10 @@ ei_x_encode_string(&x, "Banana"); Encode a tuple.

Encodes a tuple header, with a specified - arity. The next terms encoded will be the + arity. The next arity terms encoded will be the elements of the tuple. Tuples and lists are encoded recursively, so that a tuple can contain another tuple or list.

-

For example, to encode the tuple :

+

For example, to encode the tuple {a, {b, {}}}:

 ei_encode_tuple_header(buf, &i, 2);
 ei_encode_atom(buf, &i, "a");
@@ -708,8 +708,8 @@ ei_encode_tuple_header(buf, &i, 0);
intei_x_encode_ulonglong(ei_x_buff* x, unsigned long long p) Encode unsigned integer. -

Encodes a GCC or Visual C++ - (64-bit) integer in the binary +

Encodes a GCC unsigned long long or Visual C++ + unsigned __int64 (64-bit) integer in the binary format. This function is missing in the VxWorks port.

 @@ -728,13 +728,13 @@ ei_encode_tuple_header(buf, &i, 0); intei_get_type(const char *buf, const int *index, int *type, int *size) Fetch the type and size of an encoded term. -

Returns the type in and size in - of the encoded term. For strings and atoms, +

Returns the type in type and size in + size of the encoded term. For strings and atoms, size is the number of characters not including the - terminating NULL. For binaries, is the number of - bytes. For lists and tuples, is the arity of - the object. For other types, is 0. In all - cases, is left unchanged.

+ terminating NULL. For binaries, size is the number of + bytes. For lists and tuples, size is the arity of + the object. For other types, size is 0. In all + cases, index is left unchanged.

 @@ -744,21 +744,21 @@ ei_encode_tuple_header(buf, &i, 0); Print a term in clear text.

Prints a term, in clear text, to the file - specified by , or the buffer pointed to by - . It + specified by fp, or the buffer pointed to by + s. It tries to resemble the term printing in the Erlang shell.

-

In , parameter - is to +

In ei_s_print_term(), parameter + s is to point to a dynamically (malloc) allocated string of - bytes or a NULL pointer. The string - can be reallocated (and can be updated) by this - function if the result is more than + BUFSIZ bytes or a NULL pointer. The string + can be reallocated (and *s can be updated) by this + function if the result is more than BUFSIZ characters. The string returned is NULL-terminated.

The return value is the number of characters written to the file - or string, or -1 if does not + or string, or -1 if buf[index] does not contain a valid term. - Unfortunately, I/O errors on is not checked.

-

Argument is updated, that is, this function + Unfortunately, I/O errors on fp is not checked.

+

Argument index is updated, that is, this function can be viewed as a decode function that decodes a term into a human-readable format.

 @@ -772,22 +772,22 @@ ei_encode_tuple_header(buf, &i, 0); -

By default, the library is only guaranteed +

By default, the ei library is only guaranteed to be compatible with other Erlang/OTP components from the same - release as the library itself. For example, - from + release as the ei library itself. For example, + ei from Erlang/OTP R10 is not compatible with an Erlang emulator from Erlang/OTP R9 by default.

-

A call to sets - the library in compatibility mode of release - . Valid range of - +

A call to ei_set_compat_rel(release_number) sets + the ei library in compatibility mode of release + release_number. Valid range of + release_number is [7, current release]. This makes it possible to communicate with Erlang/OTP components from earlier releases.

If this function is called, it can only be called once and must be called before any other functions in the - library are called.

+ ei library are called.

You can run into trouble if this feature is used @@ -807,16 +807,16 @@ ei_encode_tuple_header(buf, &i, 0); recursively skips elements of lists and tuples, so that a full term is skipped. This is a way to get the size of an Erlang term.

-

is the buffer.

-

is updated to point right after the term +

buf is the buffer.

+

index is updated to point right after the term in the buffer.

This can be useful when you want to hold arbitrary terms: skip them and copy the binary term data to some buffer.

 -

Returns on success, otherwise - .

+

Returns 0 on success, otherwise + -1.

 @@ -825,7 +825,7 @@ ei_encode_tuple_header(buf, &i, 0); intei_x_append_buf(ei_x_buff* x, const char* buf, int len) Append a buffer at the end. -

Appends data at the end of buffer .

+

Appends data at the end of buffer x.

 @@ -836,8 +836,8 @@ ei_encode_tuple_header(buf, &i, 0);

Formats a term, given as a string, to a buffer. Works like a sprintf for Erlang terms. - contains a format string, with arguments like - , to insert terms from variables. The following + fmt contains a format string, with arguments like + ~d, to insert terms from variables. The following formats are supported (with the C types given):

 ~a  An atom, char*
@@ -853,7 +853,7 @@ ei_encode_tuple_header(buf, &i, 0);
 ei_x_format("{~a,~i,~d}", "numbers", 12, 3.14159)
 encodes the tuple {numbers,12,3.14159}
-

formats into a buffer, +

ei_x_format_wo_ver() formats into a buffer, without the initial version byte.

 @@ -862,7 +862,7 @@ encodes the tuple {numbers,12,3.14159} intei_x_free(ei_x_buff* x) Free a buffer. -

Frees an buffer. +

Frees an ei_x_buff buffer. The memory used by the buffer is returned to the OS.

 @@ -872,12 +872,12 @@ encodes the tuple {numbers,12,3.14159} intei_x_new_with_version(ei_x_buff* x) Allocate a new buffer. -

Allocates a new buffer. The - fields of the structure pointed to by parameter +

Allocates a new ei_x_buff buffer. The + fields of the structure pointed to by parameter x is filled in, and a default buffer is allocated. - also puts an initial + ei_x_new_with_version() also puts an initial version byte, which is used in the binary format (so that - will not be needed.)

+ ei_x_encode_version() will not be needed.)

 @@ -889,7 +889,7 @@ encodes the tuple {numbers,12,3.14159} Be careful with the version header, use - when appropriate. + ei_x_new_with_version() when appropriate. Turn on distribution tracing on the Erlang node. Check the result codes from ei_decode_-calls. diff --git a/lib/erl_interface/doc/src/ei_connect.xml b/lib/erl_interface/doc/src/ei_connect.xml index be34fb7c53..607a7cbff4 100644 --- a/lib/erl_interface/doc/src/ei_connect.xml +++ b/lib/erl_interface/doc/src/ei_connect.xml @@ -44,32 +44,32 @@ erlang:nodes/0 in ERTS.

-

The environment variable can be used +

The environment variable ERL_EPMD_PORT can be used to indicate which logical cluster a C-node belongs to.

Time-Out Functions

Most functions appear in a version with the suffix - appended to the function name. Those functions + _tmo appended to the function name. Those functions take an extra argument, a time-out in milliseconds. The semantics is this: for each communication primitive involved in the operation, if the primitive does not complete within the time specified, the function returns an error and - is set to . + erl_errno is set to ETIMEDOUT. With communication primitive is meant an operation on the socket, like - , , - , or .

+ connect, accept, + recv, or send.

Clearly the time-outs are for implementing fault tolerance, - not to keep hard real-time promises. The functions + not to keep hard real-time promises. The _tmo functions are for detecting non-responsive peers and to avoid blocking on socket operations.

-

A time-out value of (zero) means that time-outs are - disabled. Calling a function with the last - argument as is therefore the same thing as calling - the function without the suffix.

+

A time-out value of 0 (zero) means that time-outs are + disabled. Calling a _tmo function with the last + argument as 0 is therefore the same thing as calling + the function without the _tmo suffix.

As with all other functions starting with ei_, you are not expected @@ -80,9 +80,9 @@ avoid problems, leave the socket options alone. ei handles any socket options that need modification.

-

In all other senses, the functions inherit all +

In all other senses, the _tmo functions inherit all the return values and the semantics from the functions without - the suffix.

+ the _tmo suffix.

@@ -105,15 +105,15 @@ connection from a client process.

-

is the C-node structure.

+

ec is the C-node structure.

 -

is an open socket descriptor on - which has previously been called.

+

listensock is an open socket descriptor on + which listen() has previously been called.

 -

is a pointer to an - struct, described as follows:

+

conp is a pointer to an + ErlConnect struct, described as follows:

 -

On success, is filled in with the address and +

On success, conp is filled in with the address and node name of the connecting client and a file descriptor is - returned. On failure, is returned and - is set to .

+ returned. On failure, ERL_ERROR is returned and + erl_errno is set to EIO.

 @@ -146,34 +146,34 @@ typedef struct { Establish a connection to an Erlang node.

Sets up a connection to an Erlang node.

-

requires the IP address of the +

ei_xconnect() requires the IP address of the remote host and the alive name of the remote node to be - specified. provides an alternative + specified. ei_connect() provides an alternative interface and determines the information from the node name provided.

- is the 32-bit IP address of the remote + addr is the 32-bit IP address of the remote host. - is the alivename of the remote node. + alive is the alivename of the remote node. - is the name of the remote node. + node is the name of the remote node.

These functions return an open file descriptor on success, or a negative value indicating that an error occurred. In the latter - case they set to one of the + case they set erl_errno to one of the following:

- - The remote host is unreachable. - + EHOSTUNREACH + The remote host node is unreachable. + ENOMEM No more memory is available. - + EIO I/O error. -

Also, values from - (2) and - (2) - system calls may be propagated into .

+

Also, errno values from + socket(2) and + connect(2) + system calls may be propagated into erl_errno.

Example:

intei_connect_xinit(ei_cnode* ec, const char *thishostname, const char *thisalivename, const char *thisnodename, Erl_IpAddr thisipaddr, const char *cookie, short creation) Initialize for a connection. -

Initializes the structure, to +

Initializes the ec structure, to identify the node name and cookie of the server. One of them must be called before other functions that works on the - type or a file descriptor associated with + ei_cnode type or a file descriptor associated with a connection to another node is used.

-

is a structure containing information about - the C-node. It is used in other functions +

ec is a structure containing information about + the C-node. It is used in other ei functions for connecting and receiving data.

 -

is the registered name of the +

this_node_name is the registered name of the process (the name before '@').

 -

is the cookie for the node.

+

cookie is the cookie for the node.

 -

identifies a specific instance of a +

creation identifies a specific instance of a C-node. It can help prevent the node from receiving messages sent to an earlier process with the same registered name.

 -

is the name of the machine we are +

thishostname is the name of the machine we are running on. If long names are to be used, they are to be fully - qualified (that is, - instead of ).

+ qualified (that is, durin.erix.ericsson.se + instead of durin).

 -

is the registered name of the +

thisalivename is the registered name of the process.

 -

is the full name of the node, - that is, .

+

thisnodename is the full name of the node, + that is, einode@durin.

 -

if the IP address of the host.

+

thispaddr if the IP address of the host.

A C-node acting as a server is assigned a creation - number when it calls .

+ number when it calls ei_publish().

A connection is closed by simply closing the socket. For information about how to close the socket gracefully (when there are outgoing packets before close), see the relevant system @@ -306,32 +306,32 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { with the local name server EPMD, thereby allowing other processes to send messages by using the registered name. Before calling either of these functions, the process should - have called and + have called bind() and listen() on an open socket.

-

is the C-node structure.

+

ec is the C-node structure.

 -

is the local name to register, and is to +

port is the local name to register, and is to be the same as the port number that was previously bound to the socket.

 -

is the 32-bit IP address of the local +

addr is the 32-bit IP address of the local host.

To unregister with EPMD, simply close the returned descriptor. Do - not use , which is deprecated + not use ei_unpublish(), which is deprecated anyway.

On success, the function returns a descriptor connecting the calling process to EPMD. On failure, -1 is returned and - is set to .

-

Also, values from - (2) and - (2) system calls may be propagated - into .

+ erl_errno is set to EIO.

+

Also, errno values from + socket(2) and + connect(2) system calls may be propagated + into erl_errno.

 @@ -353,34 +353,34 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { of bytes in the Erlang external format.

-

is an open descriptor to an Erlang +

fd is an open descriptor to an Erlang connection. It is obtained from a previous - or .

+ ei_connect or ei_accept.

 -

is a buffer large enough to hold the +

bufp is a buffer large enough to hold the expected message.

 -

indicates the size of - .

+

bufsize indicates the size of + bufp.

If a tick occurs, that is, the Erlang node on the other end of the connection has polled this node to see if it - is still alive, the function returns and + is still alive, the function returns ERL_TICK and no message is placed in the buffer. Also, - is set to .

+ erl_errno is set to EAGAIN.

On success, the message is placed in the specified buffer and the function returns the number of bytes actually read. On - failure, the function returns and sets - to one of the following:

+ failure, the function returns ERL_ERROR and sets + erl_errno to one of the following:

- + EAGAIN Temporary error: Try again. - + EMSGSIZE Buffer is too small. - + EIO I/O error. @@ -394,20 +394,20 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { generated by the interface compiler and with code following examples in the same application.

In essence, the function performs the same operation as - , but instead of using an + ei_xreceive_msg, but instead of using an ei_x_buff, the function expects a pointer to a character - pointer (), where the character pointer - is to point to a memory area allocated by . - Argument is to be a pointer to an integer + pointer (mbufp), where the character pointer + is to point to a memory area allocated by malloc. + Argument bufsz is to be a pointer to an integer containing the exact size (in bytes) of the memory area. The function may reallocate the memory area and will in such cases put the new - size in and update - .

+ size in *bufsz and update + *mbufp.

Returns either ERL_TICK or the - field of the - . The length - of the message is put in . On error - a value is returned.

+ msgtype field of the + erlang_msg *msg. The length + of the message is put in *msglen. On error + a value < 0 is returned.

It is recommended to use ei_xreceive_msg instead when possible, for the sake of readability. However, the function will be retained in the interface for compatibility and @@ -432,23 +432,23 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { intei_xreceive_msg(int fd, erlang_msg* msg, ei_x_buff* x) Receive a message. -

Receives a message to the buffer in . - allows the buffer in - to grow, but +

Receives a message to the buffer in x. + ei_xreceive_msg allows the buffer in + x to grow, but ei_receive_msg fails if the message is larger than the pre-allocated buffer in - .

+ x.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is a pointer to an - structure + msg is a pointer to an + erlang_msg structure and contains information on the message received. - is buffer obtained from - . + x is buffer obtained from + ei_x_new. -

On success, the functions return and the - struct is initialized. - is defined as follows:

+

On success, the functions return ERL_MSG and the + msg struct is initialized. + erlang_msg is defined as follows:

-

identifies the type of message, and is +

msgtype identifies the type of message, and is one of the following:

- + ERL_SEND

Indicates that an ordinary send operation has occurred. - to]]> contains the pid of the recipient (the + msg->to contains the pid of the recipient (the C-node).

 - + ERL_REG_SEND

A registered send operation occurred. - from]]> contains the pid of the sender.

+ msg->from contains the pid of the sender.

 - or - + ERL_LINK or + ERL_UNLINK -

to]]> and - from]]> contain the pids of the +

msg->to and + msg->from contain the pids of the sender and recipient of the link or unlink.

 - + ERL_EXIT -

Indicates a broken link. to]]> and - from]]> contain the pids of the linked +

Indicates a broken link. msg->to and + msg->from contain the pids of the linked processes.

 @@ -520,19 +520,19 @@ typedef struct {

Sends an Erlang term to a registered process.

-

is an open descriptor to an Erlang +

fd is an open descriptor to an Erlang connection.

 - is the registered name of the + server_name is the registered name of the intended recipient. - is the buffer containing the term in + buf is the buffer containing the term in binary format. - is the length of the message in bytes. + len is the length of the message in bytes.

Returns 0 if successful, otherwise -1. In - the latter case it sets to - .

+ the latter case it sets erl_errno to + EIO.

Example:

Send the atom "ok" to the process "worker":

Remote Procedure Call from C to Erlang.

Supports calling Erlang functions on remote nodes. - sends an RPC request to a remote node - and receives the results of such a - call. combines the functionality of these + ei_rpc_to() sends an RPC request to a remote node + and ei_rpc_from() receives the results of such a + call. ei_rpc() combines the functionality of these two functions by sending an RPC request and waiting for the results. See also rpc:call/4 in Kernel.

-

is the C-node structure previously - initiated by a call to or - .

+

ec is the C-node structure previously + initiated by a call to ei_connect_init() or + ei_connect_xinit().

 -

is an open descriptor to an Erlang +

fd is an open descriptor to an Erlang connection.

 -

is the maximum time (in milliseconds) - to wait for results. Specify to +

timeout is the maximum time (in milliseconds) + to wait for results. Specify ERL_NO_TIMEOUT to wait forever. - waits infinitely for the answer, + ei_rpc() waits infinitely for the answer, that is, the call will never time out.

 -

is the name of the module containing the +

mod is the name of the module containing the function to be run on the remote node.

 -

is the name of the function to run.

+

fun is the name of the function to run.

 -

is a pointer to a buffer with an +

argbuf is a pointer to a buffer with an encoded Erlang list, without a version magic number, containing the arguments to be passed to the function.

 -

is the length of the buffer +

argbuflen is the length of the buffer containing the encoded Erlang list.

 -

is structure of type - and contains information on the +

msg is structure of type + erlang_msg and contains information on the message - received. For a description of the + received. For a description of the erlang_msg format, see ei_receive_msg.

 -

points to the dynamic buffer that receives - the result. For this is the result +

x points to the dynamic buffer that receives + the result. For ei_rpc() this is the result without the version magic number. For - the result returns a version - magic number and a 2-tuple .

+ ei_rpc_from() the result returns a version + magic number and a 2-tuple {rex,Reply}.

 -

returns the number of bytes in the +

ei_rpc() returns the number of bytes in the result on success and -1 on failure. - returns the - number of bytes, otherwise one of , - , - and . When failing, all three - functions set to one of the + ei_rpc_from() returns the + number of bytes, otherwise one of ERL_TICK, + ERL_TIMEOUT, + and ERL_ERROR. When failing, all three + functions set erl_errno to one of the following:

- + EIO I/O error. - + ETIMEDOUT Time-out expired. - + EAGAIN Temporary error: Try again.

Example:

@@ -662,11 +662,11 @@ if (ei_decode_version(result.buff, &index) < 0 Retrieve the pid of the C-node.

Retrieves the pid of the C-node. Every C-node - has a (pseudo) pid used in , - , - and others. This is contained in a field in the + has a (pseudo) pid used in ei_send_reg, + ei_rpc, + and others. This is contained in a field in the ec structure. It will be safe for a long time to fetch this - field directly from the structure.

+ field directly from the ei_cnode structure.

 @@ -676,18 +676,18 @@ if (ei_decode_version(result.buff, &index) < 0

Sends an Erlang term to a process.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is the pid of the intended recipient of + to is the pid of the intended recipient of the message. - is the buffer containing the term in + buf is the buffer containing the term in binary format. - is the length of the message in bytes. + len is the length of the message in bytes.

Returns 0 if successful, otherwise -1. In - the latter case it sets to - .

+ the latter case it sets erl_errno to + EIO.

 @@ -720,14 +720,14 @@ if (ei_decode_version(result.buff, &index) < 0

This function is retained for compatibility with code generated by the interface compiler and with code following examples in the same application.

-

The function works as with one - exception. Instead of taking as first +

The function works as ei_reg_send with one + exception. Instead of taking ei_cnode as first argument, it takes a second argument, an - , + erlang_pid, which is to be the process identifier of the sending process (in the Erlang distribution protocol).

-

A suitable can be constructed from the - structure by the following example +

A suitable erlang_pid can be constructed from the + ei_cnode structure by the following example code:

num = fd;

Can be used to retrieve information about the C-node. These values are initially set with - or - .

+ ei_connect_init() or + ei_connect_xinit().

These function simply fetch the appropriate field from the - + ec structure. Read the field directly will probably be safe for a long time, so these functions are not really needed.

 @@ -788,16 +788,16 @@ self->num = fd; -relaxed_command_check, which it normally is not.

To unregister a node you have published, you should close the descriptor that was returned by - .

+ ei_publish().

This function is deprecated and will be removed in a future release.

 -

is the node structure of the node to +

ec is the node structure of the node to unregister.

If the node was successfully unregistered from EPMD, the function returns 0. Otherwise, -1 is returned and - is set to .

+ erl_errno is set to EIO.

 @@ -818,18 +818,18 @@ self->num = fd;

If a connection attempt fails, the following can be checked:

- . + erl_errno. That the correct cookie was used That EPMD is running That the remote Erlang node on the other side is running the - same version of Erlang as the library - That environment variable + same version of Erlang as the ei library + That environment variable ERL_EPMD_PORT is set correctly

The connection attempt can be traced by setting a trace level by either - using or by setting environment - variable . + using ei_set_tracelevel or by setting environment + variable EI_TRACELEVEL. The trace levels have the following messages:

diff --git a/lib/erl_interface/doc/src/ei_users_guide.xml b/lib/erl_interface/doc/src/ei_users_guide.xml index 2c82f9ae7f..0eed50b50b 100644 --- a/lib/erl_interface/doc/src/ei_users_guide.xml +++ b/lib/erl_interface/doc/src/ei_users_guide.xml @@ -102,21 +102,21 @@ Eshell V4.7.4 (abort with ^G) /usr/local/otp ]]>

To compile your code, ensure that your C compiler knows where - to find by specifying an appropriate - argument on the command line, or add it to - the definition in your - . The correct value for this path is - , + to find erl_interface.h by specifying an appropriate + -I argument on the command line, or add it to + the CFLAGS definition in your + Makefile. The correct value for this path is + $OTPROOT/lib/erl_interface-$EIVSN/include, where:

-

is the path reported by - in the example above.

+

$OTPROOT is the path reported by + code:root_dir/0 in the example above.

 -

is the version of the Erl_Interface application, - for example, .

+

$EIVSN is the version of the Erl_Interface application, + for example, erl_interface-3.2.3.

 @@ -128,16 +128,16 @@ $ cc -c -I/usr/local/otp/lib/erl_interface-3.2.3/include myprog.c ]]>

When linking:

- Specify the path to and - with - . + Specify the path to liberl_interface.a and + libei.a with + -L$OTPROOT/lib/erl_interface-3.2.3/lib. Specify the name of the libraries with - . + -lerl_interface -lei.

Do this on the command line or add the flags to the - definition in your - .

+ LDFLAGS definition in your + Makefile.

Linking the code:

@@ -146,9 +146,9 @@ $ ld -L/usr/local/otp/lib/erl_interface-3.2.3/ lib myprog.o -lerl_interface -lei -o myprog ]]>

On some systems it can be necessary to link with some more - libraries (for example, and - on Solaris, or - on Windows) to use the + libraries (for example, libnsl.a and + libsocket.a on Solaris, or + wsock32.lib on Windows) to use the communication facilities of Erl_Interface.

If you use the Erl_Interface functions in a threaded @@ -156,18 +156,18 @@ $ ld -L/usr/local/otp/lib/erl_interface-3.2.3/ Erl_Interface needs access to some of the synchronization facilities in your threads package. You must specify extra compiler flags to indicate which of the packages you use. Define - and either or - . The default is to use POSIX threads if - is specified.

+ _REENTRANT and either STHREADS or + PTHREADS. The default is to use POSIX threads if + _REENTRANT is specified.

Initializing the Erl_Interface Library

Before calling any of the other Erl_Interface functions, call - exactly once to initialize the library. - takes two arguments. However, the arguments + erl_init() exactly once to initialize the library. + erl_init() takes two arguments. However, the arguments are no longer used by Erl_Interface and are therefore to be - specified as .

+ specified as erl_init(NULL,0).

@@ -181,7 +181,7 @@ $ ld -L/usr/local/otp/lib/erl_interface-3.2.3/ several C functions that create and manipulate Erlang data structures. The library also contains an encode and a decode function. The following example shows how to create and encode an Erlang tuple - :

+ {tobbe,3928}:

-

Alternatively, you can use and - , which handle the encoding and +

Alternatively, you can use erl_send() and + erl_receive_msg, which handle the encoding and decoding of messages transparently.

For a complete description, see the following modules:

@@ -232,8 +232,8 @@ erl_free_compound(ep); ]]>

As in the previous examples, it is your responsibility to free the memory allocated for Erlang terms. In this example, - ensures that the complete term - pointed to by is released. This is necessary + erl_free_compound() ensures that the complete term + pointed to by ep is released. This is necessary because the pointer from the second call to erl_format is lost.

The following example shows a slightly different solution:

@@ -247,7 +247,7 @@ erl_free_term(ep); erl_free_term(ep2); ]]>

In this case, you free the two terms independently. The order in - which you free the terms and + which you free the terms ep and ep2 is not important, because the Erl_Interface library uses reference counting to determine when it is safe to remove objects.

@@ -274,7 +274,7 @@ erl_eterm_release();
Pattern Matching

An Erlang pattern is a term that can contain unbound variables or - symbols. Such a pattern can be matched + "do not care" symbols. Such a pattern can be matched against a term and, if the match is successful, any unbound variables in the pattern will be bound as a side effect. The content of a bound @@ -348,7 +348,7 @@ erl_connect_init(identification_number, cookie, creation); ]]>

After initialization, you set up the connection to the Erlang node. To specify the Erlang node you want to connect to, use - . The following example sets up the + erl_connect(). The following example sets up the connection and is to result in a valid socket file descriptor:

-

prints the specified string and +

erl_err_quit() prints the specified string and terminates the program. For more information, see the erl_error module.

@@ -366,24 +366,24 @@ if ((sockfd = erl_connect(nodename)) < 0) Using EPMD

erts:epmd is the Erlang Port Mapper Daemon. Distributed - Erlang nodes register with on the local host to + Erlang nodes register with epmd on the local host to indicate to other nodes that they exist and can accept connections. - maintains a register of + epmd maintains a register of node and port number information, and when a node wishes to connect to - another node, it first contacts to find the + another node, it first contacts epmd to find the correct port number to connect to.

When you use erl_connect to connect to an Erlang node, a connection is first made to - and, if the node is known, a + epmd and, if the node is known, a connection is then made to the Erlang node.

-

C nodes can also register themselves with +

C nodes can also register themselves with epmd if they want other nodes in the system to be able to find and connect to them.

-

Before registering with , you must first +

Before registering with epmd, you must first create a listen socket and bind it to a port. Then:

-

is a file descriptor now connected to - . +

pub is a file descriptor now connected to + epmd. epmd monitors the other end of the connection. If it detects that the connection has been closed, the node becomes unregistered. So, if you explicitly close the descriptor or if your node fails, it becomes - unregistered from .

+ unregistered from epmd.

Notice that on some systems (such as VxWorks), a failed node is not detected by this mechanism, as the operating system does not automatically close descriptors that were left open when the node - failed. If a node has failed in this way, + failed. If a node has failed in this way, epmd prevents you from registering a new node with the old name, as it thinks that the old name is still in use. In this case, you must unregister the name @@ -410,7 +410,7 @@ pub = erl_publish(port); ]]> -

This causes to close the connection from the +

This causes epmd to close the connection from the far end. Notice that if the name was in fact still in use by a node, the results of this operation are unpredictable. Also, doing this does not cause the @@ -442,15 +442,15 @@ erl_unpublish(node); ]]> erl_connect:erl_receive_msg -

receives the message into a buffer, - while decodes the message into an +

erl_receive() receives the message into a buffer, + while erl_receive_msg() decodes the message into an Erlang term.

Example of Sending Messages -

In the following example, is - sent to a registered process . The message - is encoded by :

+

In the following example, {Pid, hello_world} is + sent to a registered process my_server. The message + is encoded by erl_send():

The first element of the tuple that is sent is your own - pid. This enables to reply. + pid. This enables my_server to reply. For more information about the primitives, see the erl_connect module.

Example of Receiving Messages -

In this example, is received. The +

In this example, {Pid, Something} is received. The received pid is then used to return - .

+ {goodbye,Pid}.

message. This is done automatically by - . However, when this has occurred, - returns to + ERL_TICK message. This is done automatically by + erl_receive(). However, when this has occurred, + erl_receive returns ERL_TICK to the caller without storing a message into the - structure.

+ ErlMessage structure.

When a message has been received, it is the caller's responsibility - to free the received message and - or , + to free the received message emsg.msg and + emsg.to or emsg.from, depending on the type of message received.

For more information, see the @@ -538,14 +538,14 @@ if (!erl_match(ep, reply)) erl_free_term(ep); erl_free_term(reply); ]]> -

is called to compile the specified module on - the remote node. checks that the +

c:c/1 is called to compile the specified module on + the remote node. erl_match() checks that the compilation was - successful by testing for the expected .

+ successful by testing for the expected ok.

-

For more information about and its - companions and - , see the +

For more information about erl_rpc() and its + companions erl_rpc_to() and + erl_rpc_from(), see the erl_connect module.

@@ -582,15 +582,15 @@ free(names); ]]> erl_global:erl_global_names allocates and returns a buffer containing all the names known to the global module in Kernel. - is initialized to + count is initialized to indicate the number of names in the array. The array of strings in names is terminated by a NULL pointer, so it is not necessary to use - to determine when the last name is reached.

+ count to determine when the last name is reached.

It is the caller's responsibility to free the array. erl_global_names allocates the array and all the strings - using a single call to , so - is all that is necessary.

+ using a single call to malloc(), so + free(names) is all that is necessary.

To look up one of the names:

@@ -600,16 +600,16 @@ char node[256]; pid = erl_global_whereis(fd,"schedule",node); ]]> -

If is known to the +

If "schedule" is known to the global module in Kernel, an Erlang pid is returned that can be used to send messages to the schedule service. - Also, is initialized to contain the name of + Also, node is initialized to contain the name of the node where the service is registered, so that you can make a connection to it by simply passing the variable to erl_connect.

Before registering a name, you should already have registered your - port number with . This is not strictly necessary, + port number with epmd. This is not strictly necessary, but if you neglect to do so, then other nodes wishing to communicate with your service cannot find or connect to your process.

@@ -629,7 +629,7 @@ erl_global_register(fd,servicename,pid); ]]> to wait for incoming connections.

-

Remember to free later with +

Remember to free pid later with erl_malloc:erl_free_term.

 @@ -743,7 +743,7 @@ ei_reg_close(reg); ]]> ei_reg_dump(fd, reg, "mtab", dumpflags); ]]>

This example back up the contents of the registry to the - specified Mnesia table . + specified Mnesia table "mtab". Once a registry has been backed up to Mnesia like this, more backups only affect objects that have been modified since the most recent backup, that is, @@ -756,7 +756,7 @@ ei_reg_dump(fd, reg, "mtab", dumpflags); ]]> -

This reads the entire contents of into the +

This reads the entire contents of "mtab" into the specified registry. After the restore, all the objects in the registry are marked as unmodified, so a later backup only affects objects that you have modified since the restore.

@@ -775,8 +775,8 @@ ei_reg_restore(fd, reg, "mtab"); ]]> important that some simple guidelines are followed.

Most importantly, the object must have been created with a single call - to (or similar), so that it can later be - removed by a single call to . + to malloc() (or similar), so that it can later be + removed by a single call to free(). Objects are freed by the registry when it is closed, or when you assign a new value to an object that previously contained a string or binary.

diff --git a/lib/erl_interface/doc/src/erl_call.xml b/lib/erl_interface/doc/src/erl_call.xml index 706dd271cc..f1e52b1889 100644 --- a/lib/erl_interface/doc/src/erl_call.xml +++ b/lib/erl_interface/doc/src/erl_call.xml @@ -35,9 +35,9 @@ erl_call Call/start a distributed Erlang node. -

makes it possible to start and/or +

erl_call makes it possible to start and/or communicate with a distributed Erlang node. It is built upon the - library as an example application. + Erl_Interface library as an example application. Its purpose is to use a Unix shell script to interact with a distributed Erlang node. It performs all communication with the Erlang rex server, using the standard Erlang RPC facility. It does not @@ -45,14 +45,14 @@

The main use is to either start a distributed Erlang node or to make an ordinary function call. However, it is also - possible to pipe an Erlang module to and have + possible to pipe an Erlang module to erl_call and have it compiled, or to pipe a sequence of Erlang expressions to be evaluated (similar to the Erlang shell).

-

Options, which cause to be read, can be used +

Options, which cause stdin to be read, can be used with advantage, as scripts from within (Unix) shell scripts. Another nice use - of could be from (HTTP) CGI-bin scripts.

+ of erl_call could be from (HTTP) CGI-bin scripts.

 @@ -67,65 +67,65 @@ -a [Mod [Fun [Args]]]]

(Optional.) Applies the specified function - and returns the result. must be specified. + and returns the result. Mod must be specified. However, start and [] are assumed for unspecified - and , respectively. - is to be in the same format as for + Fun and Args, respectively. + Args is to be in the same format as for erlang:apply/3 in ERTS.

Notice that this flag takes exactly one argument, so quoting - can be necessary to group , - , and in a manner + can be necessary to group Mod, + Fun, and Args in a manner dependent on the behavior of your command shell.

 -c Cookie

(Optional.) Use this option to specify a certain cookie. - If no cookie is specified, the + If no cookie is specified, the ~/.erlang.cookie file is read and its content is used as cookie. The Erlang node we want to communicate with must have the same cookie.

 -d

(Optional.) Debug mode. This causes all I/O to be output - to the file, where - + to the ~/.erl_call.out.Nodename file, where + Nodename is the node name of the Erlang node in question.

 -e

(Optional.) Reads a sequence of Erlang expressions, separated by comma (,) and ended with a full stop (.), from - until EOF (Control-D). Evaluates the + stdin until EOF (Control-D). Evaluates the expressions and returns the result from the last expression. - Returns on success.

+ Returns {ok,Result} on success.

 -h HiddenName

(Optional.) Specifies the name of the hidden node - that represents.

+ that erl_call represents.

 -m

(Optional.) Reads an Erlang module from - and compiles it.

+ stdin and compiles it.

 -n Node -

(One of is required.) - Has the same meaning as and can still be +

(One of -n, -name, -sname is required.) + Has the same meaning as -name and can still be used for backward compatibility reasons.

 -name Node -

(One of is required.) - is the name of the node to be +

(One of -n, -name, -sname is required.) + Node is the name of the node to be started or communicated with. It is assumed that - is started with - , which means that fully + Node is started with + erl -name, which means that fully qualified long node names are used. If option - is specified, an Erlang node will (if - necessary) be started with .

+ -s is specified, an Erlang node will (if + necessary) be started with erl -name.

 -q @@ -135,13 +135,13 @@ -r

(Optional.) Generates a random name of the hidden node - that represents.

+ that erl_call represents.

 -s

(Optional.) Starts a distributed Erlang node if necessary. This means that in a sequence of calls, where - '' and '' are + '-s' and '-n Node' are constant, only the first call starts the Erlang node. This makes the rest of the communication very fast. This flag is currently only available on Unix-like platforms (Linux, Mac OS X, Solaris, @@ -149,25 +149,25 @@ -sname Node -

(One of is required.) - is the name of the node to be started - or communicated with. It is assumed that - is started with , which means that - short node names are used. If option is +

(One of -n, -name, -sname is required.) + Node is the name of the node to be started + or communicated with. It is assumed that Node + is started with erl -sname, which means that + short node names are used. If option -s is specified, an Erlang node is started (if necessary) with - .

+ erl -sname.

 -v -

(Optional.) Prints a lot of +

(Optional.) Prints a lot of verbose information. This is only useful for the developer and maintainer - of .

+ of erl_call.

 -x ErlScript

(Optional.) Specifies another name of the Erlang startup script to be used. If not specified, the standard - startup script is used.

+ erl startup script is used.

 @@ -176,7 +176,7 @@
Examples -

To start an Erlang node and call :

+

To start an Erlang node and call erlang:time/0:

To terminate an Erlang node by calling - :

+ erlang:halt/0:

This function is used by a server process to accept a connection from a client process.

- is an open socket descriptor on - which has previously been called. - is a pointer to an - struct, described as follows: + listensock is an open socket descriptor on + which listen() has previously been called. + conp is a pointer to an + ErlConnect struct, described as follows: -

On success, is filled in with the address and +

On success, conp is filled in with the address and node name of the connecting client and a file descriptor is - returned. On failure, is returned and - is set to .

+ returned. On failure, ERL_ERROR is returned and + erl_errno is set to EIO.

@@ -85,9 +85,9 @@ typedef struct {

Closes an open connection to an Erlang node.

-

is a file descriptor obtained from - or - .

+

Fd is a file descriptor obtained from + erl_connect() or + erl_xconnect().

Returns 0 on success. If the call fails, a non-zero value is returned, and the reason for the error can be obtained with the appropriate platform-dependent call.

@@ -104,33 +104,33 @@ typedef struct {

Sets up a connection to an Erlang node.

-

requires the IP address of the +

erl_xconnect() requires the IP address of the remote host and the alivename of the remote node to be - specified. provides an alternative + specified. erl_connect() provides an alternative interface, and determines the information from the node name provided.

- is the 32-bit IP address of the remote + addr is the 32-bit IP address of the remote host. - is the alivename of the remote node. + alive is the alivename of the remote node. - is the name of the remote node. + node is the name of the remote node.

Returns an open file descriptor on success, otherwise a negative - value. In the latter case is set to one + value. In the latter case erl_errno is set to one of:

- - The remote host is unreachable. - + EHOSTUNREACH + The remote host node is unreachable. + ENOMEM No more memory is available. - + EIO I/O error. -

Also, values from - (2) and - (2) - system calls can be propagated into .

+

Also, errno values from + socket(2) and + connect(2) + system calls can be propagated into erl_errno.

Example:

struct in_addr *addr; -

Initializes the module. +

Initializes the erl_connect module. In particular, these functions are used to identify the name of the C-node from which they are called. One of these functions must be called before any of the other functions in the erl_connect module are used.

-

stores for later use +

erl_connect_xinit() stores for later use information about:

- Hostname of the node, - Alivename, - Node name, - IP address, - Cookie, - Creation number, + Hostname of the node, host + Alivename, alive + Node name, node + IP address, addr + Cookie, cookie + Creation number, creation -

+

erl_connect_init() provides an alternative interface that does not require as much information from the caller. Instead, - - uses to obtain default values.

-

If you use , your node will + erl_connect_init() + uses gethostbyname() to obtain default values.

+

If you use erl_connect_init(), your node will have a short name, that is, it will not be fully qualified. If you need to use fully qualified (long) names, use - instead.

+ erl_connect_xinit() instead.

-

is the name of the host on which the node +

host is the name of the host on which the node is running.

 -

is the alivename of the node.

+

alive is the alivename of the node.

 -

is the node name. It is to +

node is the node name. It is to be of the form alivename@hostname.

 -

is the 32-bit IP address of - .

+

addr is the 32-bit IP address of + host.

 -

is the authorization string required +

cookie is the authorization string required for access to the remote node. If NULL, the user HOME directory is searched for a cookie file - . The path to + .erlang.cookie. The path to the home directory is retrieved from environment variable - on Unix and from the - and - variables on Windows. For more + HOME on Unix and from the + HOMEDRIVE and + HOMEPATH variables on Windows. For more details, see the auth module in Kernel.

 -

helps identifying a particular +

creation helps identifying a particular instance of a C-node. In particular, it can help prevent us from receiving messages sent to an earlier process with the same registered name.

A C-node acting as a server is assigned a creation number - when it calls .

-

is used by - to + when it calls erl_publish().

+

number is used by + erl_connect_init() to construct the actual node name. In Example 2 below, "c17@a.DNS.name" is the resulting node name.

Example 1:

@@ -256,23 +256,23 @@ if (!erl_connect_init(17, "samplecookiestring...", 0)) with the local name server EPMD, thereby allowing other processes to send messages by using the registered name. Before calling this function, the process should - have called and + have called bind() and listen() on an open socket.

-

is the local name to register, and is to be +

port is the local name to register, and is to be the same as the port number that was previously bound to the socket.

To unregister with EPMD, simply close the returned descriptor.

On success, a descriptor connecting the calling process to EPMD is returned. On failure, -1 is returned and - is set to:

+ erl_errno is set to:

- + EIO I/O error. -

Also, values from - (2) - and (2) system calls can be - propagated into .

+

Also, errno values from + socket(2) + and connect(2) system calls can be + propagated into erl_errno.

 @@ -288,28 +288,28 @@ if (!erl_connect_init(17, "samplecookiestring...", 0))

Receives a message consisting of a sequence of bytes in the Erlang external format.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is a buffer large enough to hold the + bufp is a buffer large enough to hold the expected message. - indicates the size of - . + bufsize indicates the size of + bufp.

If a tick occurs, that is, the Erlang node on the other end of the connection has polled this node to see if it - is still alive, the function returns and + is still alive, the function returns ERL_TICK and no message is placed in the buffer. Also, - is set to .

+ erl_errno is set to EAGAIN.

On success, the message is placed in the specified buffer and the function returns the number of bytes actually read. On failure, the function returns a negative value and sets - to one of:

+ erl_errno to one of:

- + EAGAIN Temporary error: Try again. - + EMSGSIZE Buffer is too small. - + EIO I/O error. @@ -326,18 +326,18 @@ if (!erl_connect_init(17, "samplecookiestring...", 0))

Receives the message into the specified buffer - and decodes into .

+ and decodes into (ErlMessage *) emsg.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is a buffer large enough to hold the + bufp is a buffer large enough to hold the expected message. - indicates the size of - . - > is a pointer to an - structure + bufsize indicates the size of + bufp. + >emsg is a pointer to an + ErlMessage structure into which the message will be decoded. - is defined as follows: + ErlMessage is defined as follows: -

The definition of has changed since +

The definition of ErlMessage has changed since earlier versions of Erl_Interface.

 -

identifies the type of message, one of the +

type identifies the type of message, one of the following:

- + ERL_SEND

An ordinary send operation has occurred and - to]]> contains the pid of the recipient. - The message is in msg]]>.

+ emsg->to contains the pid of the recipient. + The message is in emsg->msg.

 - + ERL_REG_SEND

A registered send operation has occurred and - from]]> contains the pid of the sender. - The message is in msg]]>.

+ emsg->from contains the pid of the sender. + The message is in emsg->msg.

 - or + ERL_LINK or ERL_UNLINK -

to]]> and from]]> +

emsg->to and emsg->from contain the pids of the sender and recipient of the link or - unlink. msg]]> is not used.

+ unlink. emsg->msg is not used.

 - + ERL_EXIT -

A link is broken. to]]> and - from]]> contain the pids of the linked - processes, and msg]]> contains the reason +

A link is broken. emsg->to and + emsg->from contain the pids of the linked + processes, and emsg->msg contains the reason for the exit.

It is the caller's responsibility to release the - memory pointed to by msg]]>, - to]]>, and - from]]>.

+ memory pointed to by emsg->msg, + emsg->to, and + emsg->from.

If a tick occurs, that is, the Erlang node on the other end of the connection has polled this node to see if it - is still alive, the function returns + is still alive, the function returns ERL_TICK indicating that the tick has been received and responded to, but no message is placed in the buffer. In this case you - are to call again.

-

On success, the function returns and the - struct is initialized as described above, or - , in which case no message is returned. On - failure, the function returns and sets - to one of:

+ are to call erl_receive_msg() again.

+

On success, the function returns ERL_MSG and the + Emsg struct is initialized as described above, or + ERL_TICK, in which case no message is returned. On + failure, the function returns ERL_ERROR and sets + erl_errno to one of:

- + EMSGSIZE Buffer is too small. - + ENOMEM No more memory is available. - + EIO I/O error. @@ -421,18 +421,18 @@ typedef struct {

Sends an Erlang term to a registered process.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is a string containing the registered name + to is a string containing the registered name of the intended recipient of the message. - is the Erlang term to be sent. + msg is the Erlang term to be sent.

Returns 1 on success, otherwise 0. In - the latter case is set to one of:

+ the latter case erl_errno is set to one of:

- + ENOMEM No more memory is available. - + EIO I/O error. @@ -451,60 +451,60 @@ typedef struct {

Supports calling Erlang functions on remote nodes. - sends an RPC request to a remote node - and receives the results of such a - call. combines the functionality of + erl_rpc_to() sends an RPC request to a remote node + and erl_rpc_from() receives the results of such a + call. erl_rpc() combines the functionality of these two functions by sending an RPC request and waiting for the results. See also rpc:call/4 in Kernel.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is the maximum time (in milliseconds) + timeout is the maximum time (in milliseconds) to wait for - results. To wait forever, specify . + results. To wait forever, specify ERL_NO_TIMEOUT. When erl_rpc() calls erl_rpc_from(), the call will never timeout. - is the name of the module containing the + mod is the name of the module containing the function to be run on the remote node. - is the name of the function to run. + fun is the name of the function to run. - is an Erlang list, containing the + args is an Erlang list, containing the arguments to be passed to the function. - is a message containing the result of + emsg is a message containing the result of the function call.

The actual message returned by the RPC server - is a 2-tuple . If you use - in your code, this is the message - you will need to parse. If you use , the + is a 2-tuple {rex,Reply}. If you use + erl_rpc_from() in your code, this is the message + you will need to parse. If you use erl_rpc(), the tuple itself is parsed for you, and the message returned to your - program is the Erlang term containing only. + program is the Erlang term containing Reply only. Replies to RPC requests are always ERL_SEND messages.

It is the caller's responsibility to free the returned - structure and the memory pointed to by - msg]]> and to]]>.

+ ETERM structure and the memory pointed to by + emsg->msg and emsg->to.

 -

returns the remote function's return - value on success, otherwise .

-

returns 0 on +

erl_rpc() returns the remote function's return + value on success, otherwise NULL.

+

erl_rpc_to() returns 0 on success, otherwise a negative number.

-

returns - on success (with now +

erl_rcp_from() returns ERL_MSG + on success (with Emsg now containing the reply tuple), otherwise one of - , , or - .

+ ERL_TICK, ERL_TIMEOUT, or + ERL_ERROR.

When failing, - all three functions set to one of:

+ all three functions set erl_errno to one of:

- + ENOMEM No more memory is available. - + EIO I/O error. - + ETIMEDOUT Timeout has expired. - + EAGAIN Temporary error: Try again. @@ -520,21 +520,21 @@ typedef struct {

Sends an Erlang term to a process.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is an Erlang term containing the pid of + to is an Erlang term containing the pid of the intended recipient of the message. - > is the Erlang term to be sent. + >msg is the Erlang term to be sent.

Returns 1 on success, otherwise 0. In - the latter case is set to one of:

+ the latter case erl_errno is set to one of:

- - Invalid argument: is not a valid Erlang + EINVAL + Invalid argument: to is not a valid Erlang pid. - + ENOMEM No more memory is available. - + EIO I/O error. @@ -550,8 +550,8 @@ typedef struct {

Retrieves information about the C-node. These values are initially set with - or - .

+ erl_connect_init() or + erl_connect_xinit().

 @@ -568,17 +568,17 @@ typedef struct { -relaxed_command_check, which it normally is not.

To unregister a node you have published, you should instead close the descriptor that was returned by - .

+ ei_publish().

This function is deprecated and will be removed in a future release.

 -

is the name of the node to unregister, that +

alive is the name of the node to unregister, that is, the first component of the node name, without - .

+ @hostname.

If the node was successfully unregistered from EPMD, 0 is returned, otherwise -1 is returned and - is set to .

+ erl_errno is set to EIO.

 @@ -592,24 +592,24 @@ typedef struct { ErlMessage *emsg; -

Similar to . The difference is - that expects the buffer to - have been allocated by , and reallocates it +

Similar to erl_receive_msg. The difference is + that erl_xreceive_msg expects the buffer to + have been allocated by malloc, and reallocates it if the received message does not fit into the original buffer. Therefore both buffer and buffer length are given as pointers; their values can change by the call.

-

On success, the function returns and the - struct is initialized as described above, or - , in which case no message is returned. On - failure, the function returns and sets - to one of:

+

On success, the function returns ERL_MSG and the + Emsg struct is initialized as described above, or + ERL_TICK, in which case no message is returned. On + failure, the function returns ERL_ERROR and sets + erl_errno to one of:

- + EMSGSIZE Buffer is too small. - + ENOMEM No more memory is available. - + EIO I/O error. @@ -643,11 +643,11 @@ typedef struct {

If a connection attempt fails, the following can be checked:

- + erl_errno That the correct cookie was used That EPMD is running That the remote Erlang node on the other side is running the same - version of Erlang as the library + version of Erlang as the erl_interface library
diff --git a/lib/erl_interface/doc/src/erl_error.xml b/lib/erl_interface/doc/src/erl_error.xml index a85969d7ff..8139c9b343 100644 --- a/lib/erl_interface/doc/src/erl_error.xml +++ b/lib/erl_interface/doc/src/erl_error.xml @@ -40,9 +40,9 @@ by W. Richard Stevens.

These functions are all called in the same manner as - , that is, with a string containing format + printf(), that is, with a string containing format specifiers followed by a list of corresponding arguments. All output from - these functions is to .

+ these functions is to stderr.

@@ -54,7 +54,7 @@

The message provided by the caller is printed. This - function is simply a wrapper for .

+ function is simply a wrapper for fprintf().

 @@ -105,37 +105,37 @@ Error Reporting

Most functions in Erl_Interface report failures to the caller by returning some otherwise meaningless value (typically - + NULL or a negative number). As this only tells you that things did not - go well, examine the error code in if you + go well, examine the error code in erl_errno if you want to find out more about the failure.

volatile interl_errno - Variable contains the + Variable erl_errno contains the Erl_Interface error number. You can change the value if you wish. -

is initially (at program startup) zero +

erl_errno is initially (at program startup) zero and is then set by many Erl_Interface functions on failure to a non-zero error code to indicate what kind of error it encountered. A successful function call can change - (by calling some other function that + erl_errno (by calling some other function that fails), but no function does never set it to zero. This means - that you cannot use to see if a + that you cannot use erl_errno to see if a function call failed. Instead, each function reports failure in its own way (usually by returning a negative number or - ), in which case you can examine - for details.

-

uses the error codes defined in your - system's ]]>.

+ NULL), in which case you can examine + erl_errno for details.

+

erl_errno uses the error codes defined in your + system's <errno.h>.

-

is a "modifiable lvalue" (just - like ISO C defines to be) rather than a +

erl_errno is a "modifiable lvalue" (just + like ISO C defines errno to be) rather than a variable. This means it can be implemented as a macro - (expanding to, for example, ). + (expanding to, for example, *_erl_errno()). For reasons of thread safety (or task safety), this is exactly what we do on most platforms.

 diff --git a/lib/erl_interface/doc/src/erl_eterm.xml b/lib/erl_interface/doc/src/erl_eterm.xml index e619232e4c..9a05196a70 100644 --- a/lib/erl_interface/doc/src/erl_eterm.xml +++ b/lib/erl_interface/doc/src/erl_eterm.xml @@ -39,7 +39,7 @@ Erlang terms.

An Erlang term is represented by a C structure of type - . Applications should not reference any fields + ETERM. Applications should not reference any fields in this structure directly, as it can be changed in future releases to provide faster and more compact term storage. Instead, applications should use the macros and functions provided.

@@ -49,31 +49,31 @@ otherwise 0.

- - True if is an integer. - - True if is an integer. - - True if is a floating point number. - - True if is an atom. - - True if is a pid (process identifier). - - True if is a port. - - True if is a reference. - - True if is a tuple. - - True if is a binary. - - True if is a list with zero or more + ERL_IS_INTEGER(t) + True if t is an integer. + ERL_IS_UNSIGNED_INTEGER(t) + True if t is an integer. + ERL_IS_FLOAT(t) + True if t is a floating point number. + ERL_IS_ATOM(t) + True if t is an atom. + ERL_IS_PID(t) + True if t is a pid (process identifier). + ERL_IS_PORT(t) + True if t is a port. + ERL_IS_REF(t) + True if t is a reference. + ERL_IS_TUPLE(t) + True if t is a tuple. + ERL_IS_BINARY(t) + True if t is a binary. + ERL_IS_LIST(t) + True if t is a list with zero or more elements. - - True if is an empty list. - - True if is a list with at least one + ERL_IS_EMPTY_LIST(t) + True if t is an empty list. + ERL_IS_CONS(t) + True if t is a list with at least one element. @@ -83,60 +83,60 @@ passing a tuple to ERL_ATOM_PTR() likely results in garbage.

- + char *ERL_ATOM_PTR(t) - - A string representing atom . - + char *ERL_ATOM_PTR_UTF8(t) + A string representing atom t. + int ERL_ATOM_SIZE(t) - - The length (in bytes) of atom . - - A pointer to the contents of . - - The length (in bytes) of binary object . - - The integer of . - - The unsigned integer value of . - - The floating point value of . - + int ERL_ATOM_SIZE_UTF8(t) + The length (in bytes) of atom t. + void *ERL_BIN_PTR(t) + A pointer to the contents of t. + int ERL_BIN_SIZE(t) + The length (in bytes) of binary object t. + int ERL_INT_VALUE(t) + The integer of t. + unsigned int ERL_INT_UVALUE(t) + The unsigned integer value of t. + double ERL_FLOAT_VALUE(t) + The floating point value of t. + ETERM *ERL_PID_NODE(t) - - The node in pid . - - The sequence number in pid . - - The serial number in pid . - - The creation number in pid . - - The sequence number in port . - - The creation number in port . - + ETERM *ERL_PID_NODE_UTF8(t) + The node in pid t. + int ERL_PID_NUMBER(t) + The sequence number in pid t. + int ERL_PID_SERIAL(t) + The serial number in pid t. + int ERL_PID_CREATION(t) + The creation number in pid t. + int ERL_PORT_NUMBER(t) + The sequence number in port t. + int ERL_PORT_CREATION(t) + The creation number in port t. + ETERM *ERL_PORT_NODE(t) - - The node in port . - - The first part of the reference number in ref . + ETERM *ERL_PORT_NODE_UTF8(t) + The node in port t. + int ERL_REF_NUMBER(t) + The first part of the reference number in ref t. Use only for compatibility. - + int ERL_REF_NUMBERS(t) Pointer to the array of reference numbers in ref - . - + t. + int ERL_REF_LEN(t) The number of used reference numbers in ref - . - - The creation number in ref . - - The number of elements in tuple . - - The head element of list . - + t. + int ERL_REF_CREATION(t) + The creation number in ref t. + int ERL_TUPLE_SIZE(t) + The number of elements in tuple t. + ETERM *ERL_CONS_HEAD(t) + The head element of list t. + ETERM *ERL_CONS_TAIL(t) A list representing the tail elements of list - . + t. @@ -149,22 +149,22 @@ ETERM *tail; -

Concatenates two Erlang terms, prepending - onto and thereby creating a - cell. - To make a proper list, is always to be a list +

Concatenates two Erlang terms, prepending head + onto tail and thereby creating a + cons cell. + To make a proper list, tail is always to be a list or an empty list. Notice that NULL is not a valid list.

- is the new term to be added. - is the existing list to which - is concatenated. + head is the new term to be added. + tail is the existing list to which + head is concatenated.

The function returns a new list.

-

and - +

ERL_CONS_HEAD(list) and + ERL_CONS_TAIL(list) can be used to retrieve the head and tail components - from the list. and - do + from the list. erl_hd(list) and + erl_tl(list) do the same thing, but check that the argument really is a list.

Example:

Creates and returns a copy of the Erlang term - .

+ term.

 @@ -202,15 +202,15 @@ erl_free_compound(list);

Extracts a specified element from an Erlang tuple.

- specifies which element to retrieve - from . The elements are numbered starting + position specifies which element to retrieve + from tuple. The elements are numbered starting from 1. - is an Erlang term containing at least - elements. + tuple is an Erlang term containing at least + position elements.

Returns a new Erlang term corresponding to the requested element, or - NULL if was greater - than the arity of .

+ NULL if position was greater + than the arity of tuple.

 @@ -222,10 +222,10 @@ erl_free_compound(list);

Extracts the first element from a list.

-

is an Erlang term containing a list.

+

list is an Erlang term containing a list.

Returns an Erlang term corresponding to the head head element in the list, or a NULL pointer if - was not a list.

+ list was not a list.

 @@ -238,9 +238,9 @@ erl_free_compound(list);

This function must be called before any of the others in the - library to initialize the + Erl_Interface library to initialize the library functions. The arguments must be specified as - .

+ erl_init(NULL,0).

 @@ -252,9 +252,9 @@ erl_free_compound(list);

Returns the length of an I/O list.

-

is an Erlang term containing an I/O list.

-

Returns the length of , or - -1 if is not an I/O list.

+

list is an Erlang term containing an I/O list.

+

Returns the length of list, or + -1 if list is not an I/O list.

For the definition of an I/O list, see erl_iolist_to_binary.

@@ -269,9 +269,9 @@ erl_free_compound(list);

Converts an I/O list to a binary term.

-

is an Erlang term containing a list.

+

list is an Erlang term containing a list.

Returns an Erlang binary term, or NULL if - was not an I/O list.

+ list was not an I/O list.

Informally, an I/O list is a deep list of characters and binaries that can be sent to an Erlang port. In BNF, an I/O list is formally defined as follows:

@@ -296,15 +296,15 @@ iohead ::= Binary

Converts an I/O list to a NULL-terminated C string.

-

is an Erlang term containing an I/O list. +

list is an Erlang term containing an I/O list. The I/O list must not contain the integer 0, as C strings may not contain this value except as a terminating marker.

Returns a pointer to a dynamically allocated - buffer containing a string. If is not an I/O - list, or if contains the integer 0, + buffer containing a string. If list is not an I/O + list, or if list contains the integer 0, NULL is returned. It is the caller's responsibility to free the allocated buffer - with .

+ with erl_free().

For the definition of an I/O list, see erl_iolist_to_binary.

@@ -319,10 +319,10 @@ iohead ::= Binary

Determines the length of a proper list.

-

is an Erlang term containing a proper list. +

list is an Erlang term containing a proper list. In a proper list, all tails except the last point to another list cell, and the last tail points to an empty list.

-

Returns -1 if is not a proper +

Returns -1 if list is not a proper list.

 @@ -335,16 +335,16 @@ iohead ::= Binary

Creates an atom.

-

is the sequence of characters that will be +

string is the sequence of characters that will be used to create the atom.

Returns an Erlang term containing an atom. Notice that it is - the caller's responsibility to ensure that + the caller's responsibility to ensure that string contains a valid name for an atom.

-

and - +

ERL_ATOM_PTR(atom) and + ERL_ATOM_PTR_UTF8(atom) can be used to retrieve the atom name (as a NULL-terminated string). - - and return the length + ERL_ATOM_SIZE(atom) + and ERL_ATOM_SIZE_UTF8(atom) return the length of the atom name.

The UTF-8 variants were introduced in Erlang/OTP R16 and the @@ -365,14 +365,14 @@ iohead ::= Binary

Produces an Erlang binary object from a buffer containing a sequence of bytes.

- is a pointer to a buffer containing + bptr is a pointer to a buffer containing data to be converted. - indicates the length of - . + size indicates the length of + bptr.

Returns an Erlang binary object.

-

retrieves a pointer to - the binary data. retrieves the +

ERL_BIN_PTR(bin) retrieves a pointer to + the binary data. ERL_BIN_SIZE(bin) retrieves the size.

 @@ -397,13 +397,13 @@ iohead ::= Binary

Creates a list from a sequence of bytes.

- is a buffer containing a sequence of + string is a buffer containing a sequence of bytes. The buffer does not need to be NULL-terminated. - is the length of - . + len is the length of + string.

Returns an Erlang list object corresponding to - the character sequence in .

+ the character sequence in string.

 @@ -415,12 +415,12 @@ iohead ::= Binary

Creates an Erlang float.

-

is a value to be converted to an Erlang +

f is a value to be converted to an Erlang float.

Returns an Erlang float object with the value - specified in or if - is not finite.

-

can be used to retrieve the + specified in f or NULL if + f is not finite.

+

ERL_FLOAT_VALUE(t) can be used to retrieve the value from an Erlang float.

 @@ -433,11 +433,11 @@ iohead ::= Binary

Creates an Erlang integer.

-

is a value to be converted to an Erlang +

n is a value to be converted to an Erlang integer.

Returns an Erlang integer object with the - value specified in .

-

can be used to retrieve the + value specified in n.

+

ERL_INT_VALUE(t) can be used to retrieve the value from an Erlang integer.

 @@ -454,13 +454,13 @@ iohead ::= Binary that each element in the list corresponds to one element in the array.

- is an array of Erlang terms. - is the number of elements in - . + array is an array of Erlang terms. + arrsize is the number of elements in + array.

The function creates an Erlang list object, whose length - and whose elements are taken from the - terms in .

+ arrsize and whose elements are taken from the + terms in array.

 @@ -475,21 +475,21 @@ iohead ::= Binary

Creates an Erlang reference, with 82 bits.

- is the name of the C-node. - , , and - can be seen as one big number - , which is to be chosen + node is the name of the C-node. + n1, n2, and + n3 can be seen as one big number + n1*2^64+n2*2^32+n3, which is to be chosen uniquely for each reference created for a given C-node. - is an arbitrary number. + creation is an arbitrary number. -

Notice that and +

Notice that n3 and creation are limited in precision, so only the low 18 and 2 bits of these numbers are used.

Returns an Erlang reference object.

-

, - , - , and - can be used to retrieve the +

ERL_REF_NODE(ref), + ERL_REF_NUMBERS(ref), + ERL_REF_LEN(ref), and + ERL_REF_CREATION(ref) can be used to retrieve the values used to create the reference.

 @@ -508,18 +508,18 @@ iohead ::= Binary resulting pid can be used by Erlang processes wishing to communicate with the C-node.

- is the name of the C-node. - , , and - are + node is the name of the C-node. + number, serial, and + creation are arbitrary numbers. Notice that these are limited in precision, so only the low 15, 3, and 2 bits of these numbers are used.

Returns an Erlang pid object.

-

, - , - , and - +

ERL_PID_NODE(pid), + ERL_PID_NUMBER(pid), + ERL_PID_SERIAL(pid), and + ERL_PID_CREATION(pid) can be used to retrieve the four values used to create the pid.

 @@ -535,16 +535,16 @@ iohead ::= Binary

Creates an Erlang port identifier.

- is the name of the C-node. - and are + node is the name of the C-node. + number and creation are arbitrary numbers. Notice that these are limited in precision, so only the low 18 and 2 bits of these numbers are used.

Returns an Erlang port object.

-

, - , - and can be used to retrieve the +

ERL_PORT_NODE(port), + ERL_PORT_NUMBER(port), + and ERL_PORT_CREATION can be used to retrieve the three values used to create the port.

 @@ -559,20 +559,20 @@ iohead ::= Binary

Creates an old Erlang reference, with - only 18 bits - use instead.

+ only 18 bits - use erl_mk_long_ref instead.

- is the name of the C-node. - is to be chosen uniquely for each + node is the name of the C-node. + number is to be chosen uniquely for each reference created for a given C-node. - is an arbitrary number. + creation is an arbitrary number. -

Notice that and +

Notice that number and creation are limited in precision, so only the low 18 and 2 bits of these numbers are used.

Returns an Erlang reference object.

-

, - , and - can be used to retrieve the +

ERL_REF_NODE(ref), + ERL_REF_NUMBER(ref), and + ERL_REF_CREATION(ref) can be used to retrieve the three values used to create the reference.

 @@ -585,7 +585,7 @@ iohead ::= Binary

Creates a list from a NULL-terminated string.

-

is a NULL-terminated sequence of +

string is a NULL-terminated sequence of characters (that is, a C string) from which the list will be created.

Returns an Erlang list.

@@ -602,20 +602,20 @@ iohead ::= Binary

Creates an Erlang tuple from an array of Erlang terms.

- is an array of Erlang terms. - is the number of elements in - . + array is an array of Erlang terms. + arrsize is the number of elements in + array.

The function creates an Erlang tuple, whose arity is - and whose elements are taken from the terms - in .

+ size and whose elements are taken from the terms + in array.

To retrieve the size of a tuple, either use function - (which checks the type of the + erl_size (which checks the type of the checked term and works for a binary as well as for a tuple) or - returns the arity of a tuple. - does the same thing, but it checks + ERL_TUPLE_SIZE(tuple) returns the arity of a tuple. + erl_size() does the same thing, but it checks that the argument is a tuple. - returns the element + erl_element(index,tuple) returns the element corresponding to a given position in the tuple.

 @@ -628,11 +628,11 @@ iohead ::= Binary

Creates an Erlang unsigned integer.

-

is a value to be converted to an Erlang +

n is a value to be converted to an Erlang unsigned integer.

Returns an Erlang unsigned integer object with - the value specified in .

-

can be used to retrieve the + the value specified in n.

+

ERL_INT_UVALUE(t) can be used to retrieve the value from an Erlang unsigned integer.

 @@ -646,9 +646,9 @@ iohead ::= Binary

Creates an unbound Erlang variable. The variable can later be bound through pattern matching or assignment.

-

specifies a name for the variable.

+

name specifies a name for the variable.

Returns an Erlang variable object with the - name .

+ name name.

 @@ -662,9 +662,9 @@ iohead ::= Binary

Prints the specified Erlang term to the specified output stream.

- indicates where the function is to + stream indicates where the function is to send its output. - is the Erlang term to print. + term is the Erlang term to print.

Returns the number of characters written on success, otherwise a negative value.

@@ -678,16 +678,16 @@ iohead ::= Binary unsigned release_number; -

By default, the library is only +

By default, the Erl_Interface library is only guaranteed to be compatible with other Erlang/OTP components from the - same release as the library itself. - For example, from Erlang/OTP R10 + same release as the Erl_Interface library itself. + For example, Erl_Interface from Erlang/OTP R10 is not compatible with an Erlang emulator from Erlang/OTP R9 by default.

-

A call to sets - the library in compatibility mode of - release . Valid range of - +

A call to erl_set_compat_rel(release_number) sets + the Erl_Interface library in compatibility mode of + release release_number. Valid range of + release_number is [7, current release]. This makes it possible to communicate with Erlang/OTP components from earlier releases.

@@ -714,10 +714,10 @@ iohead ::= Binary

Returns either the arity of an Erlang tuple or the number of bytes in an Erlang binary object.

-

is an Erlang tuple or an Erlang binary +

term is an Erlang tuple or an Erlang binary object.

-

Returns the size of as described - above, or -1 if is not one of the two +

Returns the size of term as described + above, or -1 if term is not one of the two supported types.

 @@ -730,10 +730,10 @@ iohead ::= Binary

Extracts the tail from a list.

-

is an Erlang term containing a list.

+

list is an Erlang term containing a list.

Returns an Erlang list corresponding to the original list minus the first element, or NULL pointer if - was not a list.

+ list was not a list.

 @@ -747,19 +747,19 @@ iohead ::= Binary

Returns the contents of the specified variable in an Erlang term.

- is an Erlang term. In order for this + term is an Erlang term. In order for this function to succeed, - must either be an Erlang variable with + term must either be an Erlang variable with the specified name, or it must be an Erlang list or tuple containing a variable with the specified name. Other Erlang types cannot contain variables. - is the name of an Erlang variable. + name is the name of an Erlang variable.

Returns the Erlang object corresponding to the value of - in . If no variable - with the name is found in - , or if is + name in term. If no variable + with the name name is found in + term, or if term is not a valid Erlang term, NULL is returned.

 diff --git a/lib/erl_interface/doc/src/erl_format.xml b/lib/erl_interface/doc/src/erl_format.xml index f6f27326ff..5b8b7b5e78 100644 --- a/lib/erl_interface/doc/src/erl_format.xml +++ b/lib/erl_interface/doc/src/erl_format.xml @@ -49,8 +49,8 @@

A general function for creating Erlang terms using a format specifier and a corresponding set of arguments, much - in the way works.

-

is a format specification string. + in the way printf() works.

+

FormatStr is a format specification string. The valid format specifiers are as follows:

~i - Integer @@ -59,10 +59,10 @@ ~s - String ~w - Arbitrary Erlang term -

For each format specifier included in , +

For each format specifier included in FormatStr, there must be a corresponding argument following - . An Erlang term is built according to - with values and Erlang terms substituted + FormatStr. An Erlang term is built according to + FormatStr with values and Erlang terms substituted from the corresponding arguments, and according to the individual format specifiers. For example:

-

This creates an structure corresponding +

This creates an (ETERM *) structure corresponding to the Erlang term -

+ [{name,madonna},{age,21},{data,[{adr,"E-street",42}]}]

The function returns an Erlang term, or NULL if - does not describe a valid Erlang + FormatStr does not describe a valid Erlang term.

 @@ -92,18 +92,18 @@ erl_format("[{name,~a},{age,~i},{data,~w}]", section Pattern Matching in the Erlang Reference Manual.

- is an Erlang term, possibly + Pattern is an Erlang term, possibly containing unbound variables. - is an Erlang term that we wish to match - against . + Term is an Erlang term that we wish to match + against Pattern. -

and are compared - and any unbound variables in are bound to - corresponding values in .

-

If and can be +

Term and Pattern are compared + and any unbound variables in Pattern are bound to + corresponding values in Term.

+

If Term and Pattern can be matched, the function returns a non-zero value and binds any unbound - variables in . If - and do + variables in Pattern. If Term + and Pattern do not match, 0 is returned. For example:

-

can be used to retrieve the +

erl_var_content() can be used to retrieve the content of any variables bound as a result of a call to - .

+ erl_match().

 diff --git a/lib/erl_interface/doc/src/erl_global.xml b/lib/erl_interface/doc/src/erl_global.xml index 0808ea0eee..2fa0045adf 100644 --- a/lib/erl_interface/doc/src/erl_global.xml +++ b/lib/erl_interface/doc/src/erl_global.xml @@ -57,23 +57,23 @@

Retrieves a list of all known global names.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is the address of an integer, or - NULL. If is not NULL, it is + count is the address of an integer, or + NULL. If count is not NULL, it is set by the function to the number of names found.

On success, the function returns an array of strings, each containing a single registered name, and sets - to + count to the number of names found. The array is terminated by a single NULL pointer. On failure, the function returns - NULL and is not modified.

+ NULL and count is not modified.

It is the caller's responsibility to free the array afterwards. It has been allocated by the function with a - single call to , so a single - is all that is necessary.

+ single call to malloc(), so a single + free() is all that is necessary.

 @@ -89,13 +89,13 @@

Registers a name in global.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is the name to register in + name is the name to register in global. - is the pid that is to be associated with - . This value is returned by global - when processes request the location of . + pid is the pid that is to be associated with + name. This value is returned by global + when processes request the location of name.

Returns 0 on success, otherwise -1.

@@ -112,9 +112,9 @@

Unregisters a name from global.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is the name to unregister from + name is the name to unregister from global.

Returns 0 on success, otherwise -1.

@@ -132,19 +132,19 @@

Looks up a name in global.

- is an open descriptor to an Erlang + fd is an open descriptor to an Erlang connection. - is the name that is to be looked up in + name is the name that is to be looked up in global. -

If is not NULL, it is a pointer to a +

If node is not NULL, it is a pointer to a buffer where the function can fill in the name of the node where - is found. can be - passed directly to if necessary.

+ name is found. node can be + passed directly to erl_connect() if necessary.

On success, the function returns an Erlang pid containing the address of the specified name, and the node is initialized to - the node name where is found. On failure, - NULL is returned and is not + the node name where name is found. On failure, + NULL is returned and node is not modified.

 diff --git a/lib/erl_interface/doc/src/erl_interface.xml b/lib/erl_interface/doc/src/erl_interface.xml index ab5b46cc01..4e66655b39 100644 --- a/lib/erl_interface/doc/src/erl_interface.xml +++ b/lib/erl_interface/doc/src/erl_interface.xml @@ -72,51 +72,51 @@ Eshell V4.7.4 (abort with ^G) 1> code:root_dir(). /usr/local/otp ]]>

To compile your code, make sure that your C compiler knows where - to find by specifying an appropriate - argument on the command line, or by adding it to the - definition in your . The correct value for this path is - Vsn, where is the path - reported by in the above example, and Vsn is + to find erl_interface.h by specifying an appropriate -I + argument on the command line, or by adding it to the CFLAGS + definition in your Makefile. The correct value for this path is + $OTPROOT/lib/erl_interfaceVsn/include, where $OTPROOT is the path + reported by code:root_dir/0 in the above example, and Vsn is the version of the Erl_interface application, for example -

+ erl_interface-3.2.3

When linking, you will need to specify the path to - and with - , and you will need to specify the - name of the libraries with . You can do - this on the command line or by adding the flags to the - definition in your .

+ liberl_interface.a and libei.a with + -L$OTPROOT/lib/erl_interface-3.2.3/lib, and you will need to specify the + name of the libraries with -lerl_interface -lei. You can do + this on the command line or by adding the flags to the LDFLAGS + definition in your Makefile.

Also, on some systems it may be necessary to link with some - additional libraries (e.g. and on - Solaris, or on Windows) in order to use the + additional libraries (e.g. libnsl.a and libsocket.a on + Solaris, or wsock32.lib on Windows) in order to use the communication facilities of Erl_Interface.

If you are using Erl_Interface functions in a threaded application based on POSIX threads or Solaris threads, then Erl_Interface needs access to some of the synchronization facilities in your threads package, and you will need to specify additional compiler flags in order to indicate which of the packages - you are using. Define and either or - . The default is to use POSIX threads if - is specified.

+ you are using. Define _REENTRANT and either STHREADS or + PTHREADS. The default is to use POSIX threads if + _REENTRANT is specified.

Note that both single threaded and default versions of the Erl_interface and Ei libraries are provided. (The single threaded versions are named - and ). Whether the default + liberl_interface_st and libei_st). Whether the default versions of the libraries have support for threads or not is determined by if the platform in question has support for POSIX or Solaris threads. To check this, - have a look in the file in the erl_interface src directory.

+ have a look in the eidefs.mk file in the erl_interface src directory.

Initializing the erl_interface Library

Before calling any of the other Erl_Interface functions, you - must call exactly once to initialize the library. - takes two arguments, however the arguments are no + must call erl_init() exactly once to initialize the library. + erl_init() takes two arguments, however the arguments are no longer used by Erl_Interface, and should therefore be specified - as .

+ as erl_init(NULL,0).

@@ -129,7 +129,7 @@ $ ld -L/usr/local/otp/lib/erl_interface-3.2.3/ number of C functions which create and manipulate Erlang data structures. The library also contains an encode and a decode function. The example below shows how to create and encode an Erlang tuple - :

+ {tobbe,3928}:

-

Alternatively, you can use and - , which handle the encoding and decoding of +

Alternatively, you can use erl_send() and + erl_receive_msg, which handle the encoding and decoding of messages transparently.

Refer to the Reference Manual for a complete description of the following modules:

- the module for creating Erlang terms - the module for encoding and decoding routines. + the erl_eterm module for creating Erlang terms + the erl_marshal module for encoding and decoding routines.
Building Terms and Patterns

The previous example can be simplified by using - to create an Erlang term.

+ erl_format() to create an Erlang term.

-

Refer to the Reference Manual, the module, for a +

Refer to the Reference Manual, the erl_format module, for a full description of the different format directives. The following example is more complex:

As in previous examples, it is your responsibility to free the memory allocated for Erlang terms. In this example, - ensures that the complete term pointed to - by is released. This is necessary, because the pointer from - the second call to is lost.

+ erl_free_compound() ensures that the complete term pointed to + by ep is released. This is necessary, because the pointer from + the second call to erl_format() is lost.

The following example shows a slightly different solution:

In this case, you free the two terms independently. The order in - which you free the terms and is not important, + which you free the terms ep and ep2 is not important, because the Erl_Interface library uses reference counting to determine when it is safe to actually remove objects.

If you are not sure whether you have freed the terms properly, you @@ -204,14 +204,14 @@ printf("length of freelist: %ld\ /* really free the freelist */ erl_eterm_release(); ]]> -

Refer to the Reference Manual, the module for more +

Refer to the Reference Manual, the erl_malloc module for more information.

Pattern Matching

An Erlang pattern is a term that may contain unbound variables or - symbols. Such a pattern can be matched against a + "do not care" symbols. Such a pattern can be matched against a term and, if the match is successful, any unbound variables in the pattern will be bound as a side effect. The content of a bound variable can then be retrieved.

@@ -219,13 +219,13 @@ erl_eterm_release(); ETERM *pattern; pattern = erl_format("{madonna,Age,_}"); ]]> -

is used to perform pattern matching. It takes a +

erl_match() is used to perform pattern matching. It takes a pattern and a term and tries to match them. As a side effect any unbound variables in the pattern will be bound. In the following example, we create a pattern with a variable Age which appears at two positions in the tuple. The pattern match is performed as follows:

- will bind the contents of + erl_match() will bind the contents of Age to 21 the first time it reaches the variable the second occurrence of Age will cause a test for equality between the terms since Age is already bound to @@ -248,14 +248,14 @@ if (erl_match(pattern, term)) { } erl_free_term(pattern); erl_free_term(term); ]]> -

Refer to the Reference Manual, the function for +

Refer to the Reference Manual, the erl_match() function for more information.

Connecting to a Distributed Erlang Node

In order to connect to a distributed Erlang node you need to first - initialize the connection routine with , + initialize the connection routine with erl_connect_init(), which stores information such as the host name, node name, and IP address for later use:

-

Refer to the Reference Manual, the module for more information.

+

Refer to the Reference Manual, the erl_connect module for more information.

After initialization, you set up the connection to the Erlang node. - Use to specify the Erlang node you want to + Use erl_connect() to specify the Erlang node you want to connect to. The following example sets up the connection and should result in a valid socket file descriptor:

-

prints the specified string and terminates - the program. Refer to the Reference Manual, the +

erl_err_quit() prints the specified string and terminates + the program. Refer to the Reference Manual, the erl_error() function for more information.

Using EPMD -

is the Erlang Port Mapper Daemon. Distributed Erlang nodes - register with on the localhost to indicate to other nodes that - they exist and can accept connections. maintains a register of +

Epmd is the Erlang Port Mapper Daemon. Distributed Erlang nodes + register with epmd on the localhost to indicate to other nodes that + they exist and can accept connections. Epmd maintains a register of node and port number information, and when a node wishes to connect to - another node, it first contacts in order to find out the correct + another node, it first contacts epmd in order to find out the correct port number to connect to.

-

When you use to connect to an Erlang node, a - connection is first made to and, if the node is known, a +

When you use erl_connect() to connect to an Erlang node, a + connection is first made to epmd and, if the node is known, a connection is then made to the Erlang node.

-

C nodes can also register themselves with if they want other +

C nodes can also register themselves with epmd if they want other nodes in the system to be able to find and connect to them.

-

Before registering with , you need to first create a listen socket +

Before registering with epmd, you need to first create a listen socket and bind it to a port. Then:

-

is a file descriptor now connected to . +

pub is a file descriptor now connected to epmd. Epmd monitors the other end of the connection, and if it detects that the connection has been closed, the node will be unregistered. So, if you explicitly close the descriptor or if your node fails, it will be - unregistered from .

+ unregistered from epmd.

Be aware that on some systems (such as VxWorks), a failed node will not be detected by this mechanism since the operating system does not automatically close descriptors that were left open when the node - failed. If a node has failed in this way, will prevent you from + failed. If a node has failed in this way, epmd will prevent you from registering a new node with the old name, since it thinks that the old name is still in use. In this case, you must unregister the name explicitly:

-

This will cause to close the connection from the far end. Note +

This will cause epmd to close the connection from the far end. Note that if the name was in fact still in use by a node, the results of this operation are unpredictable. Also, doing this does not cause the local end of the connection to close, so resources may be consumed.

@@ -321,8 +321,8 @@ erl_unpublish(node); ]]> Sending and Receiving Erlang Messages

Use one of the following two functions to send messages:

- - + erl_send() + erl_reg_send()

As in Erlang, it is possible to send messages to a Pid or to a registered name. It is easier to send a @@ -330,17 +330,17 @@ erl_unpublish(node); ]]> a suitable Pid.

Use one of the following two functions to receive messages:

- - + erl_receive() + erl_receive_msg() -

receives the message into a buffer, while - decodes the message into an Erlang term.

+

erl_receive() receives the message into a buffer, while + erl_receive_msg() decodes the message into an Erlang term.

Example of Sending Messages -

In the following example, is - sent to a registered process . The message is encoded - by :

+

In the following example, {Pid, hello_world} is + sent to a registered process my_server. The message is encoded + by erl_send():

The first element of the tuple that is sent is your own - Pid. This enables to reply. Refer to the - Reference Manual, the module for more information + Pid. This enables my_server to reply. Refer to the + Reference Manual, the erl_connect module for more information about send primitives.

Example of Receiving Messages -

In this example is received. The - received Pid is then used to return

+

In this example {Pid, Something} is received. The + received Pid is then used to return {goodbye,Pid}

In order to provide robustness, a distributed Erlang node occasionally polls all its connected neighbours in an attempt to detect failed nodes or communication links. A node which receives such - a message is expected to respond immediately with an message. - This is done automatically by , however when this - has occurred returns to the caller - without storing a message into the structure.

+ a message is expected to respond immediately with an ERL_TICK message. + This is done automatically by erl_receive(), however when this + has occurred erl_receive returns ERL_TICK to the caller + without storing a message into the ErlMessage structure.

When a message has been received, it is the caller's responsibility - to free the received message as well as - or , depending on the type of message received.

+ to free the received message emsg.msg as well as emsg.to + or emsg.from, depending on the type of message received.

Refer to the Reference Manual for additional information about the following modules:

- - . + erl_connect + erl_eterm.
@@ -421,12 +421,12 @@ if (!erl_match(ep, reply)) "); erl_free_term(ep); erl_free_term(reply); ]]> -

is called to compile the specified module on the - remote node. checks that the compilation was - successful by testing for the expected .

-

Refer to the Reference Manual, the module for - more information about , and its companions - and .

+

c:c/1 is called to compile the specified module on the + remote node. erl_match() checks that the compilation was + successful by testing for the expected ok.

+

Refer to the Reference Manual, the erl_connect module for + more information about erl_rpc(), and its companions + erl_rpc_to() and erl_rpc_from().

@@ -454,14 +454,14 @@ if (names) ",names[i]); free(names); ]]> -

allocates and returns a buffer containing - all the names known to global. will be initialized to +

erl_global_names() allocates and returns a buffer containing + all the names known to global. count will be initialized to indicate how many names are in the array. The array of strings in names is terminated by a NULL pointer, so it is not necessary to use - to determine when the last name is reached.

+ count to determine when the last name is reached.

It is the caller's responsibility to free the array. - allocates the array and all of the strings - using a single call to , so is all + erl_global_names() allocates the array and all of the strings + using a single call to malloc(), so free(names) is all that is necessary.

To look up one of the names:

-

If is known to global, an Erlang pid is returned +

If "schedule" is known to global, an Erlang pid is returned that can be used to send messages to the schedule service. - Additionally, will be initialized to contain the name of + Additionally, node will be initialized to contain the name of the node where the service is registered, so that you can make a - connection to it by simply passing the variable to .

+ connection to it by simply passing the variable to erl_connect().

Before registering a name, you should already have registered your - port number with . This is not strictly necessary, but if you + port number with epmd. This is not strictly necessary, but if you neglect to do so, then other nodes wishing to communicate with your service will be unable to find or connect to your process.

Create a pid that Erlang processes can use to communicate with your @@ -485,9 +485,9 @@ ETERM *pid; pid = erl_mk_pid(thisnode,14,0,0); erl_global_register(fd,servicename,pid); ]]> -

After registering the name, you should use to wait for +

After registering the name, you should use erl_accept() to wait for incoming connections.

-

Do not forget to free later with !

+

Do not forget to free pid later with erl_free_term()!

To unregister a name:

@@ -570,12 +570,12 @@ ei_reg_close(reg); ]]> Backing Up the Registry to Mnesia

The contents of a registry can be backed up to Mnesia on a "nearby" Erlang node. You need to provide an open connection to the Erlang node - (see ). Also, Mnesia 3.0 or later must be running + (see erl_connect()). Also, Mnesia 3.0 or later must be running on the Erlang node before the backup is initiated:

The example above will backup the contents of the registry to the - specified Mnesia table . Once a registry has been backed + specified Mnesia table "mtab". Once a registry has been backed up to Mnesia in this manner, additional backups will only affect objects that have been modified since the most recent backup, i.e. objects that have been created, changed or deleted. The backup @@ -584,7 +584,7 @@ ei_reg_dump(fd, reg, "mtab", dumpflags); ]]>

In the same manner, a registry can be restored from a Mnesia table:

-

This will read the entire contents of into the specified +

This will read the entire contents of "mtab" into the specified registry. After the restore, all of the objects in the registry will be marked as unmodified, so a subsequent backup will only affect objects that you have modified since the restore.

@@ -600,8 +600,8 @@ ei_reg_restore(fd, reg, "mtab"); ]]>

When string or binary objects are stored in the registry it is important that a number of simple guidelines are followed.

Most importantly, the object must have been created with a single call - to (or similar), so that it can later be removed by a - single call to . Objects will be freed by the registry + to malloc() (or similar), so that it can later be removed by a + single call to free(). Objects will be freed by the registry when it is closed, or when you assign a new value to an object that previously contained a string or binary.

You should also be aware that if you store binary objects that are @@ -618,8 +618,8 @@ ei_reg_restore(fd, reg, "mtab"); ]]> you make, possibly causing it to be missed the next time you make a Mnesia backup of the registry contents. This can be avoided if you mark the object as dirty after any such changes with - , or pass appropriate flags to - .

+ ei_reg_markdirty(), or pass appropriate flags to + ei_reg_dump().

diff --git a/lib/erl_interface/doc/src/erl_malloc.xml b/lib/erl_interface/doc/src/erl_malloc.xml index e08924ec51..c0eebc29e9 100644 --- a/lib/erl_interface/doc/src/erl_malloc.xml +++ b/lib/erl_interface/doc/src/erl_malloc.xml @@ -47,8 +47,8 @@ unsigned char etype; -

Allocates an structure.

-

Specify as one of the following +

Allocates an (ETERM) structure.

+

Specify etype as one of the following constants:

ERL_INTEGER @@ -80,9 +80,9 @@ ERL_U_SMALL_BIG (bignum) -

and - are for - creating Erlang , which can contain integers +

ERL_SMALL_BIG and + ERL_U_SMALL_BIG are for + creating Erlang bignums, which can contain integers of any size. The size of an integer in Erlang is machine-dependent, but any integer > 2^28 requires a bignum.

 @@ -93,8 +93,8 @@ Clear the ETERM freelist.

Clears the freelist, where blocks are placed when they are - released by and - .

+ released by erl_free_term() and + erl_free_compound().

 @@ -107,20 +107,20 @@

Reports term allocation statistics.

-

and are +

allocated and freed are initialized to contain information about the fix-allocator used to allocate ETERM components.

-

is the number of blocks currently +

allocated is the number of blocks currently allocated to ETERM objects.

 -

is the length of the freelist, where +

freed is the length of the freelist, where blocks are placed when they are - released by and - .

+ released by erl_free_term() and + erl_free_compound().

 @@ -134,7 +134,7 @@

Calls the standard - function.

+ free() function.

 @@ -148,8 +148,8 @@

Frees an array of Erlang terms.

- is an array of ETERM* objects. - is the number of terms in the array. + array is an array of ETERM* objects. + size is the number of terms in the array. @@ -164,12 +164,12 @@

Normally it is the programmer's responsibility to free each Erlang term that has been returned from any of the - functions. However, as many of the + Erl_Interface functions. However, as many of the functions that build new Erlang terms in fact share objects with other existing terms, it can be difficult for the programmer to maintain pointers to all such terms to free them individually.

-

recursively frees all of the +

erl_free_compound() recursively frees all of the subterms associated with a specified Erlang term, regardless of whether we are still holding pointers to the subterms.

For an example, see section @@ -197,7 +197,7 @@

Calls the standard - function.

+ malloc() function.

 diff --git a/lib/erl_interface/doc/src/erl_marshal.xml b/lib/erl_interface/doc/src/erl_marshal.xml index b333bc9993..2ad658f78b 100644 --- a/lib/erl_interface/doc/src/erl_marshal.xml +++ b/lib/erl_interface/doc/src/erl_marshal.xml @@ -50,9 +50,9 @@

Compares two encoded terms.

- is a buffer containing an encoded + bufp1 is a buffer containing an encoded Erlang term term1. - is a buffer containing an encoded + bufp2 is a buffer containing an encoded Erlang term term2.

Returns 0 if the terms are equal, -1 if @@ -70,31 +70,31 @@ unsigned char **bufpp; -

and - decode +

erl_decode() and + erl_decode_buf() decode the contents of a buffer and return the corresponding - Erlang term. provides a simple + Erlang term. erl_decode_buf() provides a simple mechanism for dealing with several encoded terms stored consecutively in the buffer.

-

is a pointer to a buffer containing one +

bufp is a pointer to a buffer containing one or more encoded Erlang terms.

 -

is the address of a buffer pointer. The +

bufpp is the address of a buffer pointer. The buffer contains one or more consecutively encoded Erlang terms. Following a successful call to - , is + erl_decode_buf(), bufpp is updated so that it points to the next encoded term.

 -

returns an Erlang term - corresponding to the contents of on success, - otherwise NULL. +

erl_decode() returns an Erlang term + corresponding to the contents of bufp on success, + otherwise NULL. erl_decode_buf() returns an Erlang term corresponding to the first of the consecutive terms in - and moves forward + bufpp and moves bufpp forward to point to the next term in the buffer. On failure, each of the functions return NULL.

@@ -111,10 +111,10 @@ unsigned char **bufpp; -

and - encode +

erl_encode() and + erl_encode_buf() encode Erlang terms into external format for storage or transmission. - provides a simple mechanism for + erl_encode_buf() provides a simple mechanism for encoding several terms consecutively in the same buffer.

@@ -128,7 +128,7 @@

bufpp is a pointer to a pointer to a buffer containing one or more consecutively encoded Erlang terms. Following a successful call to - , bufpp is updated so + erl_encode_buf(), bufpp is updated so that it points to the position for the next encoded term.

 @@ -139,36 +139,36 @@ the caller's responsibility to ensure that the buffer is large enough to hold the encoded terms. You can either use a static buffer that is large enough to hold the terms you expect - to need in your program, or use + to need in your program, or use erl_term_len() to determine the exact requirements for a given term.

The following can help you estimate the buffer requirements for a term. Notice that this information is implementation-specific, and can change in future versions. - If you are unsure, use .

+ If you are unsure, use erl_term_len().

Erlang terms are encoded with a 1 byte tag that identifies the type of object, a 2- or 4-byte length field, and then the data itself. Specifically:

- + Tuples Need 5 bytes, plus the space for each element. - + Lists Need 5 bytes, plus the space for each element, and 1 more byte for the empty list at the end. - + Strings and atoms Need 3 bytes, plus 1 byte for each character (the terminating 0 is not encoded). Really long strings (more than 64k characters) are encoded as lists. Atoms cannot contain more than 256 characters. - + Integers Need 5 bytes. - + Characters (Integers < 256) need 2 bytes. - + Floating point numbers Need 32 bytes. - + Pids Need 10 bytes, plus the space for the node name, which is an atom. - + Ports and Refs Need 6 bytes, plus the space for the node name, which is an atom. @@ -198,7 +198,7 @@

Identifies and returns the type of Erlang term encoded in a buffer. It skips a trailing magic identifier.

-

Returns if the type cannot be determined or +

Returns 0 if the type cannot be determined or one of:

ERL_INTEGER @@ -238,15 +238,15 @@

This function is used for stepping over one or more encoded terms in a buffer, to directly access later term.

- is a pointer to a buffer containing one + bufp is a pointer to a buffer containing one or more encoded Erlang terms. - indicates how many terms to step over in + pos indicates how many terms to step over in the buffer.

Returns a pointer to a subterm that can be - used in a later call to to retrieve + used in a later call to erl_decode() to retrieve the term at that position. If there is no term, or - would exceed the size of the terms in the + pos would exceed the size of the terms in the buffer, NULL is returned.

 @@ -259,8 +259,8 @@

Determines the buffer space that would be - needed by if it were encoded into Erlang external - format by .

+ needed by t if it were encoded into Erlang external + format by erl_encode().

Returns the size in bytes.

 diff --git a/lib/erl_interface/doc/src/ref_man_ei.xml b/lib/erl_interface/doc/src/ref_man_ei.xml index d24828c394..92ff9ed328 100644 --- a/lib/erl_interface/doc/src/ref_man_ei.xml +++ b/lib/erl_interface/doc/src/ref_man_ei.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + EI Library Reference @@ -30,12 +30,12 @@ ref_man_ei.xml -

The library is a interface library for - communication with .

+

The ei library is a C interface library for + communication with Erlang.

-

By default, the library is only guaranteed +

By default, the ei library is only guaranteed to be compatible with other Erlang/OTP components from the same - release as the library itself. See the documentation of the + release as the ei library itself. See the documentation of the ei_set_compat_rel() function on how to communicate with Erlang/OTP components from earlier releases.

@@ -45,4 +45,3 @@ - diff --git a/lib/erl_interface/doc/src/registry.xml b/lib/erl_interface/doc/src/registry.xml index 00b8f770de..6d70fb3475 100644 --- a/lib/erl_interface/doc/src/registry.xml +++ b/lib/erl_interface/doc/src/registry.xml @@ -51,9 +51,9 @@

A registry that has previously been created with - is closed, and all the objects it + ei_reg_open() is closed, and all the objects it contains are freed.

-

is the registry to close.

+

reg is the registry to close.

Returns 0.

 @@ -73,12 +73,12 @@ well. If another object is later created with the same key, the object will be reused.

The object is removed from the registry after a call to - or . + ei_reg_dump() or ei_reg_purge().

- is the registry containing - . - is the object to remove. + reg is the registry containing + key. + key is the object to remove.

Returns 0 on success, otherwise -1.

 @@ -99,17 +99,17 @@ If any errors are encountered while backing up the data, the entire operation is aborted.

- is an open connection to Erlang. + fd is an open connection to Erlang. Mnesia 3.0 or later must be running on the Erlang node. - is the registry to back up. - is the name of the Mnesia table + reg is the registry to back up. + mntab is the name of the Mnesia table where the backed up data is to be placed. If the table does not exist, it is created automatically using configurable defaults. For information about configuring this behavior, see Mnesia. -

If is 0, the backup includes only +

If flags is 0, the backup includes only those objects that have been created, modified, or deleted since the last backup or restore (that is, an incremental backup). After the backup, any objects that were marked dirty are now clean, and any @@ -118,7 +118,7 @@ backup to be done, and EI_NOPURGE causes the deleted objects to be left in the registry afterwards. These can be bitwise OR'ed together if both behaviors are desired. If EI_NOPURGE was - specified, can be used to + specified, ei_reg_purge() can be used to explicitly remove the deleted items from the registry later.

Returns 0 on success, otherwise -1.

 @@ -132,21 +132,21 @@ const char *key; -

Gets the value associated with in the +

Gets the value associated with key in the registry. The value must be a floating point type.

- is the registry where the object will be + reg is the registry where the object will be looked up. - is the name of the object to look up. + key is the name of the object to look up.

On success, the function returns the value associated with - . + key. If the object is not found or if it is not a floating point object, -1.0 is returned. To avoid problems with in-band error reporting (that is, if you cannot distinguish between -1.0 and a valid result), use the more general function - instead.

+ ei_reg_getval() instead.

 @@ -158,21 +158,21 @@ const char *key; -

Gets the value associated with in the +

Gets the value associated with key in the registry. The value must be an integer.

- is the registry where the object will be + reg is the registry where the object will be looked up. - is the name of the object to look up. + key is the name of the object to look up.

On success, the function returns the value associated with - . + key. If the object is not found or if it is not an integer object, -1 is returned. To avoid problems with in-band error reporting (that is, if you cannot distinguish between -1 and a valid result), use the more general function - instead.

+ ei_reg_getval() instead.

 @@ -185,24 +185,24 @@ int size; -

Gets the value associated with in the +

Gets the value associated with key in the registry. The value must be a binary (pointer) type.

- is the registry where the object will be + reg is the registry where the object will be looked up. - is the name of the object to look up. + key is the name of the object to look up. - is initialized to contain the length in + size is initialized to contain the length in bytes of the object, if it is found.

On success, the function returns the value associated with - and indicates its length in - . + key and indicates its length in + size. If the object is not found or if it is not a binary object, NULL is returned. To avoid problems with in-band error reporting (that is, if you cannot distinguish between NULL and a valid result), use the more general function - instead.

+ ei_reg_getval() instead.

 @@ -214,20 +214,20 @@ const char *key; -

Gets the value associated with in the +

Gets the value associated with key in the registry. The value must be a string.

- is the registry where the object will be + reg is the registry where the object will be looked up. - is the name of the object to look up. + key is the name of the object to look up.

On success, the function returns the value associated with - . If the object is not found or if it is not a + key. If the object is not found or if it is not a string, NULL is returned. To avoid problems with in-band error reporting (that is, if you cannot distinguish between NULL and a valid result), use the more general function - instead.

+ ei_reg_getval() instead.

 @@ -245,32 +245,32 @@ object from the registry.

-

is the registry where the object will be +

reg is the registry where the object will be looked up.

 -

is the name of the object to look up.

+

key is the name of the object to look up.

 -

indicates the type of object that you - are looking for. If is 0, any +

flags indicates the type of object that you + are looking for. If flags is 0, any kind of object is returned. - If is EI_INT, EI_FLT, + If flags is EI_INT, EI_FLT, EI_STR, or EI_BIN, then only values of that kind are returned.

-

The buffer pointed to by +

The buffer pointed to by v must be large enough to hold the return data, that is, it must be - a pointer to one of , - , , or - , respectively.

-

If is EI_BIN, a fifth argument - is required, so that the size of the + a pointer to one of int, + double, char*, or + void*, respectively.

+

If flags is EI_BIN, a fifth argument + int *size is required, so that the size of the object can be returned.

 -

On success, (and if the +

On success, v (and size if the object is binary) is initialized with the value associated - with , and the function returns EI_INT, + with key, and the function returns EI_INT, EI_FLT, EI_STR, or EI_BIN, indicating the type of object. On failure, -1 is returned and the arguments are not updated.

@@ -295,9 +295,9 @@ unmodified. This function allows you to make such modifications and then let the registry know about them.

- is the registry containing the object. + reg is the registry containing the object. - is the name of the object to mark. + key is the name of the object to mark.

Returns 0 on success, otherwise -1.

@@ -312,14 +312,14 @@

Opens (creates) a registry, which initially is empty. To - close the registry later, use .

-

is the approximate number of objects you + close the registry later, use ei_reg_close().

+

size is the approximate number of objects you intend to store in the registry. As the registry uses a hash table with collision chaining, no absolute upper limit exists on the number of objects that can be stored in it. However, for reasons of efficiency, it is a good idea to choose a number that is appropriate for your needs. To change the size later, use - . Notice that the number + ei_reg_resize(). Notice that the number you provide is increased to the nearest larger prime number.

Returns an empty registry on success, otherwise NULL.

 @@ -333,13 +333,13 @@

Removes all objects marked for deletion. When objects - are deleted with they are not + are deleted with ei_reg_delete() they are not removed from the registry, only marked for later removal. On a later backup to Mnesia, the objects can also be removed from the Mnesia table. If you are not backing up to Mnesia, you may wish to remove the objects manually with this function.

-

is a registry containing objects marked for +

reg is a registry containing objects marked for deletion.

Returns 0 on success, otherwise -1.

 @@ -354,7 +354,7 @@

Changes the size of a registry.

-

is the new size to make the registry. The +

newsize is the new size to make the registry. The number is increased to the nearest larger prime number.

On success, the registry is resized, all contents rehashed, and 0 is returned. On failure, the @@ -373,17 +373,17 @@

The contents of a Mnesia table are read into the registry.

- is an open connection to Erlang. + fd is an open connection to Erlang. Mnesia 3.0 or later must be running on the Erlang node. - is the registry where the data is to be + reg is the registry where the data is to be placed. - is the name of the Mnesia table + mntab is the name of the Mnesia table to read data from.

Notice that only tables of a certain format can be restored, that is, those that have been created and backed up to - with . If the registry was not empty + with ei_reg_dump(). If the registry was not empty before the operation, the contents of the table are added to the contents of the registry. If the table contains objects with the same keys as those already in the registry, the registry objects @@ -407,16 +407,16 @@ double f; -

Creates a key-value pair with the specified - and floating point value . If an object already - exists with the same , the new value replaces +

Creates a key-value pair with the specified key + and floating point value f. If an object already + exists with the same key, the new value replaces the old one. If the previous value was a binary or string, it is - freed with .

+ freed with free().

- is the registry where the object is to be + reg is the registry where the object is to be placed. - is the object name. - is the floating point value to assign. + key is the object name. + f is the floating point value to assign.

Returns 0 on success, otherwise -1.

@@ -432,16 +432,16 @@ int i; -

Creates a key-value pair with the specified - and integer value . If an object already exists - with the same , the new value replaces the old +

Creates a key-value pair with the specified key + and integer value i. If an object already exists + with the same key, the new value replaces the old one. If the previous value was a binary or string, it is freed with - .

+ free().

- is the registry where the object is to be + reg is the registry where the object is to be placed. - is the object name. - is the integer value to assign. + key is the object name. + i is the integer value to assign.

Returns 0 on success, otherwise -1.

 @@ -457,21 +457,21 @@ int size; -

Creates a key-value pair with the specified - whose "value" is the binary object pointed to by . - If an object already exists with the same , +

Creates a key-value pair with the specified key + whose "value" is the binary object pointed to by p. + If an object already exists with the same key, the new value replaces the old one. If the previous value was a - binary or string, it is freed with .

+ binary or string, it is freed with free().

- is the registry where the object is to be + reg is the registry where the object is to be placed. - is the object name. - is a pointer to the binary object. The + key is the object name. + p is a pointer to the binary object. The object itself must have been created through a single call to - or a similar function, so that the + malloc() or a similar function, so that the registry can later delete it if necessary by calling - . - is the length in bytes of the binary + free(). + size is the length in bytes of the binary object.

Returns 0 on success, otherwise -1.

@@ -487,20 +487,20 @@ const char *s; -

Creates a key-value pair with the specified - whose "value" is the specified string . If an - object already exists with the same , the new +

Creates a key-value pair with the specified key + whose "value" is the specified string s. If an + object already exists with the same key, the new value replaces the old one. If the previous value was a binary or - string, it is freed with .

+ string, it is freed with free().

- is the registry where the object is to be + reg is the registry where the object is to be placed. - is the object name. - is the string to assign. The string itself + key is the object name. + s is the string to assign. The string itself must have been created through a single call to - or similar a function, + malloc() or similar a function, so that the registry can later delete it if - necessary by calling . + necessary by calling free().

Returns 0 on success, otherwise -1.

 @@ -516,36 +516,36 @@ v (see below) -

Creates a key-value pair with the specified - whose value is specified by . If an object already - exists with the same , the new value replaces +

Creates a key-value pair with the specified key + whose value is specified by v. If an object already + exists with the same key, the new value replaces the old one. If the previous value was a binary or string, it is freed - with .

+ with free().

-

is the registry where the object is to be +

reg is the registry where the object is to be placed.

 -

is the object name.

+

key is the object name.

 -

indicates the type of the object - specified by . Flags must be one of +

flags indicates the type of the object + specified by v. Flags must be one of EI_INT, EI_FLT, EI_STR, and EI_BIN, indicating whether - is , - , , or - .

-

If is EI_BIN, a fifth argument - is required, indicating the size - in bytes of the object pointed to by .

+ v is int, + double, char*, or + void*.

+

If flags is EI_BIN, a fifth argument + size is required, indicating the size + in bytes of the object pointed to by v.

If you wish to store an arbitrary pointer in the registry, - specify a of 0. In this case, the + specify a size of 0. In this case, the object itself is not transferred by an - operation, only the pointer + ei_reg_dump() operation, only the pointer value.

Returns 0 on success, otherwise -1.

 @@ -562,11 +562,11 @@

Returns information about an object.

- is the registry containing the object. + reg is the registry containing the object. - is the object name. - is a pointer to an - structure, defined as follows: + key is the object name. + obuf is a pointer to an + ei_reg_stat structure, defined as follows: -

In the attributes of the object are stored +

In attr the attributes of the object are stored as the logical OR of its type (one of EI_INT, EI_FLT, EI_BIN, and EI_STR), whether it is marked for deletion (EI_DELET), and whether it has been modified since the last backup to Mnesia (EI_DIRTY).

-

Field indicates the size in bytes required +

Field size indicates the size in bytes required to store EI_STR (including the terminating 0) and EI_BIN objects, or 0 for EI_INT and EI_FLT.

-

Returns 0 and initializes on success, +

Returns 0 and initializes obuf on success, otherwise -1.

 @@ -601,10 +601,10 @@ struct ei_reg_stat { returned by this function, you can see whether the size of the registry is suitable for the amount of data it contains.

- is the registry to return information + reg is the registry to return information about. - is a pointer to an - structure, defined as follows: + obuf is a pointer to an + ei_reg_tabstat structure, defined as follows: -

Field indicates the number of hash positions +

Field size indicates the number of hash positions in the registry. This is the number you provided when you created or last resized the registry, rounded up to the nearest prime number.

- indicates the number of elements stored + nelem indicates the number of elements stored in the registry. It includes objects that are deleted but not purged. - indicates the number of unique positions + npos indicates the number of unique positions that are occupied in the registry. - indicates how many elements are + collisions indicates how many elements are sharing positions in the registry.

On success, 0 is returned and - is initialized to contain table statistics, + obuf is initialized to contain table statistics, otherwise -1 is returned.

 -- cgit v1.2.3