File: application_ei.kwc

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 23,284 kB
  • ctags: 10,724
  • sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (246 lines) | stat: -rw-r--r-- 8,508 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
%% Automatically generated. Do not edit.
{srcfile, "application_ei"}.
{appname, "erl_interface"}.
{appvsn, "3.5.5.2"}.
{lib, "ei"}.
{libsummary, " routines for handling the erlang binary term format "}.
{name, "ei_set_compat_rel/1"}.
{fsummary, "Set the ei library in compatibility mode"}.
{name, "ei_encode_version/2"}.
{name, "ei_x_encode_version/1"}.
{fsummary, "Encode version"}.
{name, "ei_encode_long/3"}.
{name, "ei_x_encode_long/2"}.
{fsummary, "Encode integer"}.
{name, "ei_encode_ulong/3"}.
{name, "ei_x_encode_ulong/2"}.
{fsummary, "Encode unsigned integer"}.
{name, "ei_encode_longlong/3"}.
{name, "ei_x_encode_longlong/2"}.
{fsummary, "Encode integer"}.
{name, "ei_encode_ulonglong/3"}.
{name, "ei_x_encode_ulonglong/2"}.
{fsummary, "Encode unsigned integer"}.
{name, "ei_encode_bignum/3"}.
{name, "ei_x_encode_bignum/2"}.
{fsummary, "Encode an arbitrary precision integer"}.
{name, "ei_encode_double/3"}.
{name, "ei_x_encode_double/2"}.
{fsummary, "Encode a double float"}.
{name, "ei_encode_boolean/3"}.
{name, "ei_x_encode_boolean/2"}.
{fsummary, "Encode a boolean"}.
{name, "ei_encode_char/3"}.
{name, "ei_x_encode_char/2"}.
{fsummary, "Encode an 8-bit integer between 0-255"}.
{name, "ei_encode_string/3"}.
{name, "ei_encode_string_len/4"}.
{name, "ei_x_encode_string/2"}.
{name, "ei_x_encode_string_len/3"}.
{fsummary, "Encode a string"}.
{name, "ei_encode_atom/3"}.
{name, "ei_encode_atom_len/4"}.
{name, "ei_x_encode_atom/2"}.
{name, "ei_x_encode_atom_len/3"}.
{fsummary, "Encode an atom"}.
{name, "ei_encode_binary/4"}.
{name, "ei_x_encode_binary/3"}.
{fsummary, "Encode a binary"}.
{name, "ei_encode_pid/3"}.
{name, "ei_x_encode_pid/2"}.
{fsummary, "Encode a pid"}.
{name, "ei_encode_fun/3"}.
{name, "ei_x_encode_fun/2"}.
{fsummary, "Encode a fun"}.
{name, "ei_encode_port/3"}.
{name, "ei_x_encode_port/2"}.
{fsummary, "Encodes a port"}.
{name, "ei_encode_ref/3"}.
{name, "ei_x_encode_ref/2"}.
{fsummary, "Encodes a ref"}.
{name, "ei_encode_term/3"}.
{name, "ei_x_encode_term/2"}.
{fsummary, "Encode an erl_interface term"}.
{name, "ei_encode_trace/3"}.
{name, "ei_x_encode_trace/2"}.
{fsummary, "Encode a trace token"}.
{name, "ei_encode_tuple_header/3"}.
{name, "ei_x_encode_tuple_header/2"}.
{fsummary, "Encode a tuple"}.
{name, "ei_encode_list_header/3"}.
{name, "ei_x_encode_list_header/2"}.
{fsummary, "Encode a list"}.
{name, "ei_encode_empty_list/2"}.
{name, "ei_x_encode_empty_list/1"}.
{fsummary, "Encode an empty list (nil)"}.
{name, "ei_get_type/4"}.
{fsummary, "Fetch the type and size of an encoded term"}.
{name, "ei_decode_version/3"}.
{fsummary, "Encode an empty list (nil)"}.
{name, "ei_decode_long/3"}.
{fsummary, "Decode integer"}.
{name, "ei_decode_ulong/3"}.
{fsummary, "Decode unsigned integer"}.
{name, "ei_decode_longlong/3"}.
{fsummary, "Decode integer"}.
{name, "ei_decode_ulonglong/3"}.
{fsummary, "Decode unsigned integer"}.
{name, "ei_decode_bignum/3"}.
{fsummary, "Decode a GMP arbitrary precision integer"}.
{name, "ei_decode_double/3"}.
{fsummary, "Decode a double"}.
{name, "ei_decode_boolean/3"}.
{fsummary, "Decode a boolean"}.
{name, "ei_decode_char/3"}.
{fsummary, "Decode an 8-bit integer between 0-255"}.
{name, "ei_decode_string/3"}.
{fsummary, "Decode a string"}.
{name, "ei_decode_atom/3"}.
{fsummary, "Decode an atom"}.
{name, "ei_decode_binary/4"}.
{fsummary, "Decode a binary"}.
{name, "ei_decode_fun/3"}.
{name, "free_fun/1"}.
{fsummary, "Decode a fun"}.
{name, "ei_decode_pid/3"}.
{fsummary, "Decode a pid"}.
{name, "ei_decode_port/3"}.
{fsummary, "Decode a port"}.
{name, "ei_decode_ref/3"}.
{fsummary, "Decode a reference"}.
{name, "ei_decode_trace/3"}.
{fsummary, "Decode a trace token"}.
{name, "ei_decode_tuple_header/3"}.
{fsummary, "Decode a tuple"}.
{name, "ei_decode_list_header/3"}.
{fsummary, "Decode a list"}.
{name, "ei_decode_ei_term/3"}.
{fsummary, "Decode a term, without prior knowledge of type"}.
{name, "ei_decode_term/3"}.
{fsummary, "Decode a ETERM"}.
{name, "ei_print_term/3"}.
{name, "ei_s_print_term/3"}.
{fsummary, "Print a term in clear text"}.
{name, "ei_x_format/3"}.
{name, "ei_x_format_wo_ver/3"}.
{fsummary, "Format a term from a format string and parameters."}.
{name, "ei_x_new/1"}.
{name, "ei_x_new_with_version/1"}.
{fsummary, "Allocate a new buffer"}.
{name, "ei_x_free/1"}.
{fsummary, "Frees a buffer"}.
{name, "ei_x_append/2"}.
{name, "ei_x_append_buf/3"}.
{fsummary, "Appends a buffer at the end"}.
{name, "ei_skip_term/2"}.
{fsummary, "skip a term"}.
{lib, "ei_connect"}.
{libsummary, "Communicate with distributed erlang"}.
{name, "ei_connect_init/4"}.
{name, "ei_connect_xinit/7"}.
{fsummary, "Initialize for a connection."}.
{name, "ei_connect/2"}.
{name, "ei_xconnect/3"}.
{fsummary, "Establishe a connection to an Erlang node"}.
{name, "ei_connect_tmo/3"}.
{name, "ei_xconnect_tmo/4"}.
{fsummary, "Establish a connection to an Erlang node with optional timeout"}.
{name, "ei_receive/3"}.
{fsummary, "Receive a message"}.
{name, "ei_receive_tmo/4"}.
{fsummary, "Receive a message with optional timeout"}.
{name, "ei_receive_msg/3"}.
{name, "ei_xreceive_msg/3"}.
{fsummary, "Receive a message"}.
{name, "ei_receive_msg_tmo/4"}.
{name, "ei_xreceive_msg_tmo/4"}.
{fsummary, "Receive a message with optional timeout"}.
{name, "ei_receive_encoded/5"}.
{fsummary, "Obsolete function for receiving a message"}.
{name, "ei_receive_encoded_tmo/6"}.
{fsummary, "Obsolete function for receiving a message with timeout"}.
{name, "ei_send/4"}.
{fsummary, "Send a message"}.
{name, "ei_send_tmo/5"}.
{fsummary, "Send a message with optional timeout"}.
{name, "ei_send_encoded/4"}.
{fsummary, "Obsolete function to send a message"}.
{name, "ei_send_encoded_tmo/5"}.
{fsummary, "Obsolete function to send a message with optional timeout"}.
{name, "ei_reg_send/5"}.
{fsummary, "Send a message to a registered name"}.
{name, "ei_reg_send_tmo/6"}.
{fsummary, "Send a message to a registered name with optional   timeout "}.
{name, "ei_send_reg_encoded/5"}.
{fsummary, "Obsolete function to send a message to a registered name"}.
{name, "ei_send_reg_encoded_tmo/5"}.
{fsummary, "Obsolete function to send a message to a registered name with timeout"}.
{name, "ei_rpc/7"}.
{name, "ei_rpc_to/6"}.
{name, "ei_rpc_from/5"}.
{fsummary, "Remote Procedure Call from C to Erlang"}.
{name, "ei_publish/2"}.
{fsummary, "Publish a node name"}.
{name, "ei_publish_tmo/3"}.
{fsummary, "Publish a node name with optional timeout"}.
{name, "ei_accept/3"}.
{fsummary, "Accept a connection from another node"}.
{name, "ei_accept_tmo/4"}.
{fsummary, "Accept a connection from another node with optional timeout"}.
{name, "ei_unpublish/1"}.
{fsummary, "Unpublish a node name"}.
{name, "ei_unpublish_tmo/2"}.
{fsummary, "Unpublish a node name with optional timeout"}.
{name, "ei_thisnodename/1"}.
{name, "ei_thishostname/1"}.
{name, "ei_thisalivename/1"}.
{fsummary, "Retrieve some values"}.
{name, "ei_self/1"}.
{fsummary, "Retrieve the Pid of the C-node"}.
{name, "*ei_gethostbyname/1"}.
{name, "*ei_gethostbyaddr/3"}.
{name, "*ei_gethostbyname_r/5"}.
{name, "*ei_gethostbyaddr_r/7"}.
{fsummary, "Name lookup functions"}.
{lib, "registry"}.
{libsummary, "Store and backup key-value pairs"}.
{name, "ei_reg_open/1"}.
{fsummary, "Create and open a registry"}.
{name, "ei_reg_resize/2"}.
{fsummary, "Resize a registry"}.
{name, "ei_reg_close/1"}.
{fsummary, "Close a registry "}.
{name, "ei_reg_setival/3"}.
{fsummary, "Assign an integer object"}.
{name, "ei_reg_setfval/3"}.
{fsummary, "Assign a floating point object"}.
{name, "ei_reg_setsval/3"}.
{fsummary, "Assign a string object"}.
{name, "ei_reg_setpval/4"}.
{fsummary, "Assign a binary object"}.
{name, "ei_reg_setval/5"}.
{fsummary, "Assign a value to any object type"}.
{name, "ei_reg_getival/2"}.
{fsummary, "Get an integer object"}.
{name, "ei_reg_getfval/2"}.
{fsummary, "Get a floating point object"}.
{name, "ei_reg_getsval/2"}.
{fsummary, "Get a string object"}.
{name, "ei_reg_getpval/3"}.
{fsummary, "Get a binary object"}.
{name, "ei_reg_getval/5"}.
{fsummary, "Get any object"}.
{name, "ei_reg_markdirty/2"}.
{fsummary, "Mark an object as dirty "}.
{name, "ei_reg_delete/2"}.
{fsummary, "Delete an object from the registry"}.
{name, "ei_reg_stat/3"}.
{fsummary, "Get object information"}.
{name, "ei_reg_tabstat/2"}.
{fsummary, "Get registry information"}.
{name, "ei_reg_dump/4"}.
{fsummary, "Back up a registry to Mnesia"}.
{name, "ei_reg_restore/3"}.
{fsummary, "Restore a registry from Mnesia"}.
{name, "ei_reg_purge/1"}.
{fsummary, "Remove deleted objects"}.