<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- registry</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/erl_interface-3.7.9.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>Erlang Interface</strong><br><strong>Reference Manual</strong><br><small>Version 3.7.9</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p>
<ul class="flipMenu">
<li id="no" title="ei " expanded="false">ei<ul>
<li><a href="ei.html">
Top of manual page
</a></li>
<li title="ei_set_compat_rel"><a href="ei.html#ei_set_compat_rel">ei_set_compat_rel()
</a></li>
<li title="ei_encode_version"><a href="ei.html#ei_encode_version">ei_encode_version()
</a></li>
<li title="ei_x_encode_version"><a href="ei.html#ei_x_encode_version">ei_x_encode_version()
</a></li>
<li title="ei_encode_long"><a href="ei.html#ei_encode_long">ei_encode_long()
</a></li>
<li title="ei_x_encode_long"><a href="ei.html#ei_x_encode_long">ei_x_encode_long()
</a></li>
<li title="ei_encode_ulong"><a href="ei.html#ei_encode_ulong">ei_encode_ulong()
</a></li>
<li title="ei_x_encode_ulong"><a href="ei.html#ei_x_encode_ulong">ei_x_encode_ulong()
</a></li>
<li title="ei_encode_longlong"><a href="ei.html#ei_encode_longlong">ei_encode_longlong()
</a></li>
<li title="ei_x_encode_longlong"><a href="ei.html#ei_x_encode_longlong">ei_x_encode_longlong()
</a></li>
<li title="ei_encode_ulonglong"><a href="ei.html#ei_encode_ulonglong">ei_encode_ulonglong()
</a></li>
<li title="ei_x_encode_ulonglong"><a href="ei.html#ei_x_encode_ulonglong">ei_x_encode_ulonglong()
</a></li>
<li title="ei_encode_bignum"><a href="ei.html#ei_encode_bignum">ei_encode_bignum()
</a></li>
<li title="ei_x_encode_bignum"><a href="ei.html#ei_x_encode_bignum">ei_x_encode_bignum()
</a></li>
<li title="ei_encode_double"><a href="ei.html#ei_encode_double">ei_encode_double()
</a></li>
<li title="ei_x_encode_double"><a href="ei.html#ei_x_encode_double">ei_x_encode_double()
</a></li>
<li title="ei_encode_boolean"><a href="ei.html#ei_encode_boolean">ei_encode_boolean()
</a></li>
<li title="ei_x_encode_boolean"><a href="ei.html#ei_x_encode_boolean">ei_x_encode_boolean()
</a></li>
<li title="ei_encode_char"><a href="ei.html#ei_encode_char">ei_encode_char()
</a></li>
<li title="ei_x_encode_char"><a href="ei.html#ei_x_encode_char">ei_x_encode_char()
</a></li>
<li title="ei_encode_string"><a href="ei.html#ei_encode_string">ei_encode_string()
</a></li>
<li title="ei_encode_string_len"><a href="ei.html#ei_encode_string_len">ei_encode_string_len()
</a></li>
<li title="ei_x_encode_string"><a href="ei.html#ei_x_encode_string">ei_x_encode_string()
</a></li>
<li title="ei_x_encode_string_len"><a href="ei.html#ei_x_encode_string_len">ei_x_encode_string_len()
</a></li>
<li title="ei_encode_atom"><a href="ei.html#ei_encode_atom">ei_encode_atom()
</a></li>
<li title="ei_encode_atom_len"><a href="ei.html#ei_encode_atom_len">ei_encode_atom_len()
</a></li>
<li title="ei_x_encode_atom"><a href="ei.html#ei_x_encode_atom">ei_x_encode_atom()
</a></li>
<li title="ei_x_encode_atom_len"><a href="ei.html#ei_x_encode_atom_len">ei_x_encode_atom_len()
</a></li>
<li title="ei_encode_binary"><a href="ei.html#ei_encode_binary">ei_encode_binary()
</a></li>
<li title="ei_x_encode_binary"><a href="ei.html#ei_x_encode_binary">ei_x_encode_binary()
</a></li>
<li title="ei_encode_pid"><a href="ei.html#ei_encode_pid">ei_encode_pid()
</a></li>
<li title="ei_x_encode_pid"><a href="ei.html#ei_x_encode_pid">ei_x_encode_pid()
</a></li>
<li title="ei_encode_fun"><a href="ei.html#ei_encode_fun">ei_encode_fun()
</a></li>
<li title="ei_x_encode_fun"><a href="ei.html#ei_x_encode_fun">ei_x_encode_fun()
</a></li>
<li title="ei_encode_port"><a href="ei.html#ei_encode_port">ei_encode_port()
</a></li>
<li title="ei_x_encode_port"><a href="ei.html#ei_x_encode_port">ei_x_encode_port()
</a></li>
<li title="ei_encode_ref"><a href="ei.html#ei_encode_ref">ei_encode_ref()
</a></li>
<li title="ei_x_encode_ref"><a href="ei.html#ei_x_encode_ref">ei_x_encode_ref()
</a></li>
<li title="ei_encode_term"><a href="ei.html#ei_encode_term">ei_encode_term()
</a></li>
<li title="ei_x_encode_term"><a href="ei.html#ei_x_encode_term">ei_x_encode_term()
</a></li>
<li title="ei_encode_trace"><a href="ei.html#ei_encode_trace">ei_encode_trace()
</a></li>
<li title="ei_x_encode_trace"><a href="ei.html#ei_x_encode_trace">ei_x_encode_trace()
</a></li>
<li title="ei_encode_tuple_header"><a href="ei.html#ei_encode_tuple_header">ei_encode_tuple_header()
</a></li>
<li title="ei_x_encode_tuple_header"><a href="ei.html#ei_x_encode_tuple_header">ei_x_encode_tuple_header()
</a></li>
<li title="ei_encode_list_header"><a href="ei.html#ei_encode_list_header">ei_encode_list_header()
</a></li>
<li title="ei_x_encode_list_header"><a href="ei.html#ei_x_encode_list_header">ei_x_encode_list_header()
</a></li>
<li title="ei_encode_empty_list"><a href="ei.html#ei_encode_empty_list">ei_encode_empty_list()
</a></li>
<li title="ei_x_encode_empty_list"><a href="ei.html#ei_x_encode_empty_list">ei_x_encode_empty_list()
</a></li>
<li title="ei_get_type"><a href="ei.html#ei_get_type">ei_get_type()
</a></li>
<li title="ei_decode_version"><a href="ei.html#ei_decode_version">ei_decode_version()
</a></li>
<li title="ei_decode_long"><a href="ei.html#ei_decode_long">ei_decode_long()
</a></li>
<li title="ei_decode_ulong"><a href="ei.html#ei_decode_ulong">ei_decode_ulong()
</a></li>
<li title="ei_decode_longlong"><a href="ei.html#ei_decode_longlong">ei_decode_longlong()
</a></li>
<li title="ei_decode_ulonglong"><a href="ei.html#ei_decode_ulonglong">ei_decode_ulonglong()
</a></li>
<li title="ei_decode_bignum"><a href="ei.html#ei_decode_bignum">ei_decode_bignum()
</a></li>
<li title="ei_decode_double"><a href="ei.html#ei_decode_double">ei_decode_double()
</a></li>
<li title="ei_decode_boolean"><a href="ei.html#ei_decode_boolean">ei_decode_boolean()
</a></li>
<li title="ei_decode_char"><a href="ei.html#ei_decode_char">ei_decode_char()
</a></li>
<li title="ei_decode_string"><a href="ei.html#ei_decode_string">ei_decode_string()
</a></li>
<li title="ei_decode_atom"><a href="ei.html#ei_decode_atom">ei_decode_atom()
</a></li>
<li title="ei_decode_binary"><a href="ei.html#ei_decode_binary">ei_decode_binary()
</a></li>
<li title="ei_decode_fun"><a href="ei.html#ei_decode_fun">ei_decode_fun()
</a></li>
<li title="free_fun"><a href="ei.html#free_fun">free_fun()
</a></li>
<li title="ei_decode_pid"><a href="ei.html#ei_decode_pid">ei_decode_pid()
</a></li>
<li title="ei_decode_port"><a href="ei.html#ei_decode_port">ei_decode_port()
</a></li>
<li title="ei_decode_ref"><a href="ei.html#ei_decode_ref">ei_decode_ref()
</a></li>
<li title="ei_decode_trace"><a href="ei.html#ei_decode_trace">ei_decode_trace()
</a></li>
<li title="ei_decode_tuple_header"><a href="ei.html#ei_decode_tuple_header">ei_decode_tuple_header()
</a></li>
<li title="ei_decode_list_header"><a href="ei.html#ei_decode_list_header">ei_decode_list_header()
</a></li>
<li title="ei_decode_ei_term"><a href="ei.html#ei_decode_ei_term">ei_decode_ei_term()
</a></li>
<li title="ei_decode_term"><a href="ei.html#ei_decode_term">ei_decode_term()
</a></li>
<li title="ei_print_term"><a href="ei.html#ei_print_term">ei_print_term()
</a></li>
<li title="ei_s_print_term"><a href="ei.html#ei_s_print_term">ei_s_print_term()
</a></li>
<li title="ei_x_format"><a href="ei.html#ei_x_format">ei_x_format()
</a></li>
<li title="ei_x_format_wo_ver"><a href="ei.html#ei_x_format_wo_ver">ei_x_format_wo_ver()
</a></li>
<li title="ei_x_new"><a href="ei.html#ei_x_new">ei_x_new()
</a></li>
<li title="ei_x_new_with_version"><a href="ei.html#ei_x_new_with_version">ei_x_new_with_version()
</a></li>
<li title="ei_x_free"><a href="ei.html#ei_x_free">ei_x_free()
</a></li>
<li title="ei_x_append"><a href="ei.html#ei_x_append">ei_x_append()
</a></li>
<li title="ei_x_append_buf"><a href="ei.html#ei_x_append_buf">ei_x_append_buf()
</a></li>
<li title="ei_skip_term"><a href="ei.html#ei_skip_term">ei_skip_term()
</a></li>
</ul>
</li>
<li id="no" title="ei_connect " expanded="false">ei_connect<ul>
<li><a href="ei_connect.html">
Top of manual page
</a></li>
<li title="ei_connect_init"><a href="ei_connect.html#ei_connect_init">ei_connect_init()
</a></li>
<li title="ei_connect_xinit"><a href="ei_connect.html#ei_connect_xinit">ei_connect_xinit()
</a></li>
<li title="ei_connect"><a href="ei_connect.html#ei_connect">ei_connect()
</a></li>
<li title="ei_xconnect"><a href="ei_connect.html#ei_xconnect">ei_xconnect()
</a></li>
<li title="ei_connect_tmo"><a href="ei_connect.html#ei_connect_tmo">ei_connect_tmo()
</a></li>
<li title="ei_xconnect_tmo"><a href="ei_connect.html#ei_xconnect_tmo">ei_xconnect_tmo()
</a></li>
<li title="ei_receive"><a href="ei_connect.html#ei_receive">ei_receive()
</a></li>
<li title="ei_receive_tmo"><a href="ei_connect.html#ei_receive_tmo">ei_receive_tmo()
</a></li>
<li title="ei_receive_msg"><a href="ei_connect.html#ei_receive_msg">ei_receive_msg()
</a></li>
<li title="ei_xreceive_msg"><a href="ei_connect.html#ei_xreceive_msg">ei_xreceive_msg()
</a></li>
<li title="ei_receive_msg_tmo"><a href="ei_connect.html#ei_receive_msg_tmo">ei_receive_msg_tmo()
</a></li>
<li title="ei_xreceive_msg_tmo"><a href="ei_connect.html#ei_xreceive_msg_tmo">ei_xreceive_msg_tmo()
</a></li>
<li title="ei_receive_encoded"><a href="ei_connect.html#ei_receive_encoded">ei_receive_encoded()
</a></li>
<li title="ei_receive_encoded_tmo"><a href="ei_connect.html#ei_receive_encoded_tmo">ei_receive_encoded_tmo()
</a></li>
<li title="ei_send"><a href="ei_connect.html#ei_send">ei_send()
</a></li>
<li title="ei_send_tmo"><a href="ei_connect.html#ei_send_tmo">ei_send_tmo()
</a></li>
<li title="ei_send_encoded"><a href="ei_connect.html#ei_send_encoded">ei_send_encoded()
</a></li>
<li title="ei_send_encoded_tmo"><a href="ei_connect.html#ei_send_encoded_tmo">ei_send_encoded_tmo()
</a></li>
<li title="ei_reg_send"><a href="ei_connect.html#ei_reg_send">ei_reg_send()
</a></li>
<li title="ei_reg_send_tmo"><a href="ei_connect.html#ei_reg_send_tmo">ei_reg_send_tmo()
</a></li>
<li title="ei_send_reg_encoded"><a href="ei_connect.html#ei_send_reg_encoded">ei_send_reg_encoded()
</a></li>
<li title="ei_send_reg_encoded_tmo"><a href="ei_connect.html#ei_send_reg_encoded_tmo">ei_send_reg_encoded_tmo()
</a></li>
<li title="ei_rpc"><a href="ei_connect.html#ei_rpc">ei_rpc()
</a></li>
<li title="ei_rpc_to"><a href="ei_connect.html#ei_rpc_to">ei_rpc_to()
</a></li>
<li title="ei_rpc_from"><a href="ei_connect.html#ei_rpc_from">ei_rpc_from()
</a></li>
<li title="ei_publish"><a href="ei_connect.html#ei_publish">ei_publish()
</a></li>
<li title="ei_publish_tmo"><a href="ei_connect.html#ei_publish_tmo">ei_publish_tmo()
</a></li>
<li title="ei_accept"><a href="ei_connect.html#ei_accept">ei_accept()
</a></li>
<li title="ei_accept_tmo"><a href="ei_connect.html#ei_accept_tmo">ei_accept_tmo()
</a></li>
<li title="ei_unpublish"><a href="ei_connect.html#ei_unpublish">ei_unpublish()
</a></li>
<li title="ei_unpublish_tmo"><a href="ei_connect.html#ei_unpublish_tmo">ei_unpublish_tmo()
</a></li>
<li title="ei_thisnodename"><a href="ei_connect.html#ei_thisnodename">ei_thisnodename()
</a></li>
<li title="ei_thishostname"><a href="ei_connect.html#ei_thishostname">ei_thishostname()
</a></li>
<li title="ei_thisalivename"><a href="ei_connect.html#ei_thisalivename">ei_thisalivename()
</a></li>
<li title="ei_self"><a href="ei_connect.html#ei_self">ei_self()
</a></li>
<li title="*ei_gethostbyname"><a href="ei_connect.html#*ei_gethostbyname">*ei_gethostbyname()
</a></li>
<li title="*ei_gethostbyaddr"><a href="ei_connect.html#*ei_gethostbyaddr">*ei_gethostbyaddr()
</a></li>
<li title="*ei_gethostbyname_r"><a href="ei_connect.html#*ei_gethostbyname_r">*ei_gethostbyname_r()
</a></li>
<li title="*ei_gethostbyaddr_r"><a href="ei_connect.html#*ei_gethostbyaddr_r">*ei_gethostbyaddr_r()
</a></li>
<li title="ei_get_tracelevel"><a href="ei_connect.html#ei_get_tracelevel">ei_get_tracelevel()
</a></li>
<li title="ei_set_tracelevel"><a href="ei_connect.html#ei_set_tracelevel">ei_set_tracelevel()
</a></li>
</ul>
</li>
<li id="loadscrollpos" title="registry " expanded="true">registry<ul>
<li><a href="registry.html">
Top of manual page
</a></li>
<li title="ei_reg_open"><a href="registry.html#ei_reg_open">ei_reg_open()
</a></li>
<li title="ei_reg_resize"><a href="registry.html#ei_reg_resize">ei_reg_resize()
</a></li>
<li title="ei_reg_close"><a href="registry.html#ei_reg_close">ei_reg_close()
</a></li>
<li title="ei_reg_setival"><a href="registry.html#ei_reg_setival">ei_reg_setival()
</a></li>
<li title="ei_reg_setfval"><a href="registry.html#ei_reg_setfval">ei_reg_setfval()
</a></li>
<li title="ei_reg_setsval"><a href="registry.html#ei_reg_setsval">ei_reg_setsval()
</a></li>
<li title="ei_reg_setpval"><a href="registry.html#ei_reg_setpval">ei_reg_setpval()
</a></li>
<li title="ei_reg_setval"><a href="registry.html#ei_reg_setval">ei_reg_setval()
</a></li>
<li title="ei_reg_getival"><a href="registry.html#ei_reg_getival">ei_reg_getival()
</a></li>
<li title="ei_reg_getfval"><a href="registry.html#ei_reg_getfval">ei_reg_getfval()
</a></li>
<li title="ei_reg_getsval"><a href="registry.html#ei_reg_getsval">ei_reg_getsval()
</a></li>
<li title="ei_reg_getpval"><a href="registry.html#ei_reg_getpval">ei_reg_getpval()
</a></li>
<li title="ei_reg_getval"><a href="registry.html#ei_reg_getval">ei_reg_getval()
</a></li>
<li title="ei_reg_markdirty"><a href="registry.html#ei_reg_markdirty">ei_reg_markdirty()
</a></li>
<li title="ei_reg_delete"><a href="registry.html#ei_reg_delete">ei_reg_delete()
</a></li>
<li title="ei_reg_stat"><a href="registry.html#ei_reg_stat">ei_reg_stat()
</a></li>
<li title="ei_reg_tabstat"><a href="registry.html#ei_reg_tabstat">ei_reg_tabstat()
</a></li>
<li title="ei_reg_dump"><a href="registry.html#ei_reg_dump">ei_reg_dump()
</a></li>
<li title="ei_reg_restore"><a href="registry.html#ei_reg_restore">ei_reg_restore()
</a></li>
<li title="ei_reg_purge"><a href="registry.html#ei_reg_purge">ei_reg_purge()
</a></li>
</ul>
</li>
<li id="no" title="erl_connect " expanded="false">erl_connect<ul>
<li><a href="erl_connect.html">
Top of manual page
</a></li>
<li title="erl_connect_init"><a href="erl_connect.html#erl_connect_init">erl_connect_init()
</a></li>
<li title="erl_connect_xinit"><a href="erl_connect.html#erl_connect_xinit">erl_connect_xinit()
</a></li>
<li title="erl_connect"><a href="erl_connect.html#erl_connect">erl_connect()
</a></li>
<li title="erl_xconnect"><a href="erl_connect.html#erl_xconnect">erl_xconnect()
</a></li>
<li title="erl_close_connection"><a href="erl_connect.html#erl_close_connection">erl_close_connection()
</a></li>
<li title="erl_receive"><a href="erl_connect.html#erl_receive">erl_receive()
</a></li>
<li title="erl_receive_msg"><a href="erl_connect.html#erl_receive_msg">erl_receive_msg()
</a></li>
<li title="erl_xreceive_msg"><a href="erl_connect.html#erl_xreceive_msg">erl_xreceive_msg()
</a></li>
<li title="erl_send"><a href="erl_connect.html#erl_send">erl_send()
</a></li>
<li title="erl_reg_send"><a href="erl_connect.html#erl_reg_send">erl_reg_send()
</a></li>
<li title="erl_rpc"><a href="erl_connect.html#erl_rpc">erl_rpc()
</a></li>
<li title="erl_rpc_to"><a href="erl_connect.html#erl_rpc_to">erl_rpc_to()
</a></li>
<li title="erl_rpc_from"><a href="erl_connect.html#erl_rpc_from">erl_rpc_from()
</a></li>
<li title="erl_publish"><a href="erl_connect.html#erl_publish">erl_publish()
</a></li>
<li title="erl_accept"><a href="erl_connect.html#erl_accept">erl_accept()
</a></li>
<li title="erl_thiscookie"><a href="erl_connect.html#erl_thiscookie">erl_thiscookie()
</a></li>
<li title="erl_thisnodename"><a href="erl_connect.html#erl_thisnodename">erl_thisnodename()
</a></li>
<li title="erl_thishostname"><a href="erl_connect.html#erl_thishostname">erl_thishostname()
</a></li>
<li title="erl_thisalivename"><a href="erl_connect.html#erl_thisalivename">erl_thisalivename()
</a></li>
<li title="erl_thiscreation"><a href="erl_connect.html#erl_thiscreation">erl_thiscreation()
</a></li>
<li title="erl_unpublish"><a href="erl_connect.html#erl_unpublish">erl_unpublish()
</a></li>
<li title="*erl_gethostbyname"><a href="erl_connect.html#*erl_gethostbyname">*erl_gethostbyname()
</a></li>
<li title="*erl_gethostbyaddr"><a href="erl_connect.html#*erl_gethostbyaddr">*erl_gethostbyaddr()
</a></li>
<li title="*erl_gethostbyname_r"><a href="erl_connect.html#*erl_gethostbyname_r">*erl_gethostbyname_r()
</a></li>
<li title="*erl_gethostbyaddr_r"><a href="erl_connect.html#*erl_gethostbyaddr_r">*erl_gethostbyaddr_r()
</a></li>
</ul>
</li>
<li id="no" title="erl_error " expanded="false">erl_error<ul>
<li><a href="erl_error.html">
Top of manual page
</a></li>
<li title="erl_err_msg"><a href="erl_error.html#erl_err_msg">erl_err_msg()
</a></li>
<li title="erl_err_quit"><a href="erl_error.html#erl_err_quit">erl_err_quit()
</a></li>
<li title="erl_err_ret"><a href="erl_error.html#erl_err_ret">erl_err_ret()
</a></li>
<li title="erl_err_sys"><a href="erl_error.html#erl_err_sys">erl_err_sys()
</a></li>
<li title=""><a href="erl_error.html#">erl_errno()
</a></li>
</ul>
</li>
<li id="no" title="erl_eterm " expanded="false">erl_eterm<ul>
<li><a href="erl_eterm.html">
Top of manual page
</a></li>
<li title="erl_cons"><a href="erl_eterm.html#erl_cons">erl_cons()
</a></li>
<li title="erl_copy_term"><a href="erl_eterm.html#erl_copy_term">erl_copy_term()
</a></li>
<li title="erl_element"><a href="erl_eterm.html#erl_element">erl_element()
</a></li>
<li title="erl_init"><a href="erl_eterm.html#erl_init">erl_init()
</a></li>
<li title="erl_hd"><a href="erl_eterm.html#erl_hd">erl_hd()
</a></li>
<li title="erl_iolist_to_binary"><a href="erl_eterm.html#erl_iolist_to_binary">erl_iolist_to_binary()
</a></li>
<li title="erl_iolist_to_string"><a href="erl_eterm.html#erl_iolist_to_string">erl_iolist_to_string()
</a></li>
<li title="erl_iolist_length"><a href="erl_eterm.html#erl_iolist_length">erl_iolist_length()
</a></li>
<li title="erl_length"><a href="erl_eterm.html#erl_length">erl_length()
</a></li>
<li title="erl_mk_atom"><a href="erl_eterm.html#erl_mk_atom">erl_mk_atom()
</a></li>
<li title="erl_mk_binary"><a href="erl_eterm.html#erl_mk_binary">erl_mk_binary()
</a></li>
<li title="erl_mk_empty_list"><a href="erl_eterm.html#erl_mk_empty_list">erl_mk_empty_list()
</a></li>
<li title="erl_mk_estring"><a href="erl_eterm.html#erl_mk_estring">erl_mk_estring()
</a></li>
<li title="erl_mk_float"><a href="erl_eterm.html#erl_mk_float">erl_mk_float()
</a></li>
<li title="erl_mk_int"><a href="erl_eterm.html#erl_mk_int">erl_mk_int()
</a></li>
<li title="erl_mk_list"><a href="erl_eterm.html#erl_mk_list">erl_mk_list()
</a></li>
<li title="erl_mk_pid"><a href="erl_eterm.html#erl_mk_pid">erl_mk_pid()
</a></li>
<li title="erl_mk_port"><a href="erl_eterm.html#erl_mk_port">erl_mk_port()
</a></li>
<li title="erl_mk_ref"><a href="erl_eterm.html#erl_mk_ref">erl_mk_ref()
</a></li>
<li title="erl_mk_long_ref"><a href="erl_eterm.html#erl_mk_long_ref">erl_mk_long_ref()
</a></li>
<li title="erl_mk_string"><a href="erl_eterm.html#erl_mk_string">erl_mk_string()
</a></li>
<li title="erl_mk_tuple"><a href="erl_eterm.html#erl_mk_tuple">erl_mk_tuple()
</a></li>
<li title="erl_mk_uint"><a href="erl_eterm.html#erl_mk_uint">erl_mk_uint()
</a></li>
<li title="erl_mk_var"><a href="erl_eterm.html#erl_mk_var">erl_mk_var()
</a></li>
<li title="erl_print_term"><a href="erl_eterm.html#erl_print_term">erl_print_term()
</a></li>
<li title="erl_set_compat_rel"><a href="erl_eterm.html#erl_set_compat_rel">erl_set_compat_rel()
</a></li>
<li title="erl_size"><a href="erl_eterm.html#erl_size">erl_size()
</a></li>
<li title="erl_tl"><a href="erl_eterm.html#erl_tl">erl_tl()
</a></li>
<li title="erl_var_content"><a href="erl_eterm.html#erl_var_content">erl_var_content()
</a></li>
</ul>
</li>
<li id="no" title="erl_format " expanded="false">erl_format<ul>
<li><a href="erl_format.html">
Top of manual page
</a></li>
<li title="erl_format"><a href="erl_format.html#erl_format">erl_format()
</a></li>
<li title="erl_match"><a href="erl_format.html#erl_match">erl_match()
</a></li>
</ul>
</li>
<li id="no" title="erl_global " expanded="false">erl_global<ul>
<li><a href="erl_global.html">
Top of manual page
</a></li>
<li title="erl_global_names"><a href="erl_global.html#erl_global_names">erl_global_names()
</a></li>
<li title="erl_global_register"><a href="erl_global.html#erl_global_register">erl_global_register()
</a></li>
<li title="erl_global_unregister"><a href="erl_global.html#erl_global_unregister">erl_global_unregister()
</a></li>
<li title="erl_global_whereis"><a href="erl_global.html#erl_global_whereis">erl_global_whereis()
</a></li>
</ul>
</li>
<li id="no" title="erl_malloc " expanded="false">erl_malloc<ul>
<li><a href="erl_malloc.html">
Top of manual page
</a></li>
<li title="erl_alloc_eterm"><a href="erl_malloc.html#erl_alloc_eterm">erl_alloc_eterm()
</a></li>
<li title="erl_eterm_release"><a href="erl_malloc.html#erl_eterm_release">erl_eterm_release()
</a></li>
<li title="erl_eterm_statistics"><a href="erl_malloc.html#erl_eterm_statistics">erl_eterm_statistics()
</a></li>
<li title="erl_free_array"><a href="erl_malloc.html#erl_free_array">erl_free_array()
</a></li>
<li title="erl_free_term"><a href="erl_malloc.html#erl_free_term">erl_free_term()
</a></li>
<li title="erl_free_compound"><a href="erl_malloc.html#erl_free_compound">erl_free_compound()
</a></li>
<li title="erl_malloc"><a href="erl_malloc.html#erl_malloc">erl_malloc()
</a></li>
<li title="erl_free"><a href="erl_malloc.html#erl_free">erl_free()
</a></li>
</ul>
</li>
<li id="no" title="erl_marshal " expanded="false">erl_marshal<ul>
<li><a href="erl_marshal.html">
Top of manual page
</a></li>
<li title="erl_compare_ext"><a href="erl_marshal.html#erl_compare_ext">erl_compare_ext()
</a></li>
<li title="erl_decode"><a href="erl_marshal.html#erl_decode">erl_decode()
</a></li>
<li title="erl_decode_buf"><a href="erl_marshal.html#erl_decode_buf">erl_decode_buf()
</a></li>
<li title="erl_encode"><a href="erl_marshal.html#erl_encode">erl_encode()
</a></li>
<li title="erl_encode_buf"><a href="erl_marshal.html#erl_encode_buf">erl_encode_buf()
</a></li>
<li title="erl_ext_size"><a href="erl_marshal.html#erl_ext_size">erl_ext_size()
</a></li>
<li title="erl_ext_type"><a href="erl_marshal.html#erl_ext_type">erl_ext_type()
</a></li>
<li title="erl_peek_ext"><a href="erl_marshal.html#erl_peek_ext">erl_peek_ext()
</a></li>
<li title="erl_term_len"><a href="erl_marshal.html#erl_term_len">erl_term_len()
</a></li>
</ul>
</li>
<li title="erl_call"><a href="erl_call.html">erl_call</a></li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><h1>registry</h1></center>
<h3>C LIBRARY</h3>
<div class="REFBODY">registry</div>
<h3>LIBRARY SUMMARY</h3>
<div class="REFBODY">Store and backup key-value pairs</div>
<h3>DESCRIPTION</h3>
<div class="REFBODY"><p>
<p>This module provides support for storing key-value
pairs in a table known as a registry, backing up registries to
Mnesia in an atomic manner, and later restoring the contents of a
registry from Mnesia.</p>
</p></div>
<h3>EXPORTS</h3>
<p><a name="ei_reg_open"><span class="bold_code">ei_reg *ei_reg_open(size)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">int size;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Open (create) a registry. The registry will be
initially empty. Use <span class="code">ei_reg_close()</span> to close the registry
later.
</p>
<p><span class="code">size</span> is the approximate number of objects you intend
to store in the registry. Since the registry uses a hash table
with collision chaining, there is no absolute upper limit 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. It is possible to use
<span class="code">ei_reg_resize()</span> to change the size later. Note that the
number you provide will be increased to the nearest larger prime
number.
</p>
<p>On success, an empty registry will be returned. On failure, NULL
will be returned.</p>
</p></div>
<p><a name="ei_reg_resize"><span class="bold_code">int ei_reg_resize(reg,newsize)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">int newsize;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Change the size of a registry.
</p>
<p><span class="code">newsize</span> is the new size to make the registry. The
number will be increased to the nearest larger prime number.
</p>
<p>On success, the registry will be resized, all contents
rehashed, and the function will return 0. On failure, the
registry will be left unchanged and the function will return -1.</p>
</p></div>
<p><a name="ei_reg_close"><span class="bold_code">int ei_reg_close(reg)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>A registry that has previously been created with
<span class="code">ei_reg_open()</span> is closed, and all the objects it contains
are freed.
</p>
<p><span class="code">reg</span> is the registry to close.
</p>
<p>The function returns 0.</p>
</p></div>
<p><a name="ei_reg_setival"><span class="bold_code">int ei_reg_setival(reg,key,i)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">int i;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Create a key-value pair with the specified <span class="code">key</span> and integer
value <span class="code">i</span>. If an object already existed with the same
<span class="code">key</span>, the new value replaces the old one. If the previous
value was a binary or string, it is freed with <span class="code">free()</span>.
</p>
<p><span class="code">reg</span> is the registry where the object should be placed.
</p>
<p><span class="code">key</span> is the name of the object.
</p>
<p><span class="code">i</span> is the integer value to assign.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
<p><a name="ei_reg_setfval"><span class="bold_code">int ei_reg_setfval(reg,key,f)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">double f;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Create a key-value pair with the specified <span class="code">key</span> and
floating point value <span class="code">f</span>. If an object already existed with
the same <span class="code">key</span>, the new value replaces the old one. If the
previous value was a binary or string, it is freed with <span class="code">free()</span>.
</p>
<p><span class="code">reg</span> is the registry where the object should be placed.
</p>
<p><span class="code">key</span> is the name of the object.
</p>
<p><span class="code">f</span> is the floating point value to assign.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
<p><a name="ei_reg_setsval"><span class="bold_code">int ei_reg_setsval(reg,key,s)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *s;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Create a key-value pair with the specified <span class="code">key</span> whose
"value" is the specified string <span class="code">s</span>. If an object already
existed with the same <span class="code">key</span>, the new value replaces the old
one. If the previous value was a binary or string, it is freed
with <span class="code">free()</span>.
</p>
<p><span class="code">reg</span> is the registry where the object should be placed.
</p>
<p><span class="code">key</span> is the name of the object.
</p>
<p><span class="code">s</span> is the string to assign. The string itself
must have been created through a single call to <span class="code">malloc()</span> or
similar function, so that the registry can later delete it if
necessary by calling <span class="code">free()</span>.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
<p><a name="ei_reg_setpval"><span class="bold_code">int ei_reg_setpval(reg,key,p,size)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const void *p;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">int size;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Create a key-value pair with the specified <span class="code">key</span> whose
"value" is the binary object pointed to by <span class="code">p</span>. If an
object already existed with the same <span class="code">key</span>, the new value
replaces the old one. If the previous value was a binary or
string, it is freed with <span class="code">free()</span>.
</p>
<p><span class="code">reg</span> is the registry where the object should be placed.
</p>
<p><span class="code">key</span> is the name of the object.
</p>
<p><span class="code">p</span> is a pointer to the binary object. The object itself
must have been created through a single call to <span class="code">malloc()</span> or
similar function, so that the registry can later delete it if
necessary by calling <span class="code">free()</span>.
</p>
<p><span class="code">size</span> is the length in bytes of the binary object.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
<p><a name="ei_reg_setval"><span class="bold_code">int ei_reg_setval(reg,key,flags,v,...)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">int flags;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">v (see below)</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Create a key-value pair with the specified <span class="code">key</span> whose
value is specified by <span class="code">v</span>. If an object already
existed with the same <span class="code">key</span>, the new value replaces the old
one. If the previous value was a binary or string, it is freed
with <span class="code">free()</span>.
</p>
<p><span class="code">reg</span> is the registry where the object should be placed.
</p>
<p><span class="code">key</span> is the name of the object.
</p>
<p><span class="code">flags</span> indicates the type of the object specified by
<span class="code">v</span>. Flags must be one of EI_INT, EI_FLT, EI_STR and
EI_BIN, indicating whether <span class="code">v</span> is <span class="code">int</span>, <span class="code">double</span>,
<span class="code">char*</span> or <span class="code">void*</span>. If <span class="code">flags</span> is EI_BIN, then a
fifth argument <span class="code">size</span> is required, indicating the size
in bytes of the object pointed to by <span class="code">v</span>.
</p>
<p>If you wish to store an arbitrary pointer in the registry,
specify a <span class="code">size</span> of 0. In this case, the object itself will
not be transferred by an <span class="code">ei_reg_dump()</span> operation, just
the pointer value.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
<p><a name="ei_reg_getival"><span class="bold_code">int ei_reg_getival(reg,key)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get the value associated with <span class="code">key</span> in the
registry. The value must be an integer.
</p>
<p><span class="code">reg</span> is the registry where the object will be looked
up.
</p>
<p><span class="code">key</span> is the name of the object to look up.
</p>
<p>On success, the function returns the value associated with <span class="code">key</span>.
If the object was not found or it was not an integer
object, -1 is returned. To avoid problems with in-band error
reporting (i.e. if you cannot distinguish between -1 and a
valid result) use the more general function <span class="code">ei_reg_getval()</span>
instead.</p>
</p></div>
<p><a name="ei_reg_getfval"><span class="bold_code">double ei_reg_getfval(reg,key)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get the value associated with <span class="code">key</span> in the
registry. The value must be a floating point type.
</p>
<p><span class="code">reg</span> is the registry where the object will be looked
up.
</p>
<p><span class="code">key</span> is the name of the object to look up.
</p>
<p>On success, the function returns the value associated with <span class="code">key</span>.
If the object was not found or it was not a floating point
object, -1.0 is returned. To avoid problems with in-band error
reporting (i.e. if you cannot distinguish between -1.0 and a
valid result) use the more general function <span class="code">ei_reg_getval()</span>
instead.</p>
</p></div>
<p><a name="ei_reg_getsval"><span class="bold_code">const char *ei_reg_getsval(reg,key)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get the value associated with <span class="code">key</span> in the
registry. The value must be a string.
</p>
<p><span class="code">reg</span> is the registry where the object will be looked
up.
</p>
<p><span class="code">key</span> is the name of the object to look up.
</p>
<p>On success, the function returns the value associated with
<span class="code">key</span>. If the object was not found or it was not a string,
NULL is returned. To avoid problems with in-band error
reporting (i.e. if you cannot distinguish between NULL and a
valid result) use the more general function <span class="code">ei_reg_getval()</span>
instead.</p>
</p></div>
<p><a name="ei_reg_getpval"><span class="bold_code">const void *ei_reg_getpval(reg,key,size)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">int size;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get the value associated with <span class="code">key</span> in the
registry. The value must be a binary (pointer) type.
</p>
<p><span class="code">reg</span> is the registry where the object will be looked
up.
</p>
<p><span class="code">key</span> is the name of the object to look up.
</p>
<p><span class="code">size</span> will be initialized to contain the length in
bytes of the object, if it is found.
</p>
<p>On success, the function returns the value associated with
<span class="code">key</span> and indicates its length in <span class="code">size</span>.
If the object was not found or it was not a binary object,
NULL is returned. To avoid problems with in-band error
reporting (i.e. if you cannot distinguish between NULL and a
valid result) use the more general function <span class="code">ei_reg_getval()</span>
instead.</p>
</p></div>
<p><a name="ei_reg_getval"><span class="bold_code">int ei_reg_getval(reg,key,flags,v,...)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">int flags;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">void *v (see below)</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This is a general function for retrieving any kind of
object from the registry.
</p>
<p><span class="code">reg</span> is the registry where the object will be looked
up.
</p>
<p><span class="code">key</span> is the name of the object to look up.
</p>
<p><span class="code">flags</span> indicates the type of object that you are
looking for. If <span class="code">flags</span> is 0, then any kind of object will
be returned. If <span class="code">flags</span> is one of EI_INT, EI_FLT, EI_STR or
EI_BIN, then only values of that kind will be returned. The
buffer pointed to by <span class="code">v</span> must be large enough to hold the return
data, i.e. it must be a pointer to one of <span class="code">int</span>,
<span class="code">double</span>, <span class="code">char*</span> or <span class="code">void*</span>, respectively. Also,
if <span class="code">flags</span> is EI_BIN, then a fifth argument <span class="code">int *size</span> is required, so that the size of the object can be
returned.
</p>
<p>If the function succeeds, <span class="code">v</span> (and <span class="code">size</span> if the
object is binary) will be initialized with the value associated
with <span class="code">key</span>, and the function will return one of EI_INT,
EI_FLT, EI_STR or EI_BIN, indicating the type of object. On failure the
function will return -1 and the arguments will not be updated.</p>
</p></div>
<p><a name="ei_reg_markdirty"><span class="bold_code">int ei_reg_markdirty(reg,key)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Mark a registry object as dirty. This will ensure that
it is included in the next backup to Mnesia. Normally this
operation will not be necessary since all of the normal registry
'set' functions do this automatically. However if you have
retrieved the value of a string or binary object from the
registry and modified the contents, then the change will be
invisible to the registry and the object will be assumed to be
unmodified. This function allows you to make such modifications
and then let the registry know about them.
</p>
<p><span class="code">reg</span> is the registry containing the object.
</p>
<p><span class="code">key</span> is the name of the object to mark.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
<p><a name="ei_reg_delete"><span class="bold_code">int ei_reg_delete(reg,key)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Delete an object from the registry. The object is not
actually removed from the registry, it is only marked for later
removal so that on subsequent backups to Mnesia, the
corresponding object can be removed from the Mnesia table as
well. If another object is later created with the same key, the
object will be reused.
</p>
<p>The object will be removed from the registry after a call to
<span class="code">ei_reg_dump()</span> or <span class="code">ei_reg_purge()</span>.
</p>
<p><span class="code">reg</span> is the registry containing <span class="code">key</span>.
</p>
<p><span class="code">key</span> is the object to remove.
</p>
<p>If the object was found, the function returns 0 indicating
success. Otherwise the function returns -1.</p>
</p></div>
<p><a name="ei_reg_stat"><span class="bold_code">int ei_reg_stat(reg,key,obuf)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *key;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">struct ei_reg_stat *obuf;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Return information about an object.
</p>
<p><span class="code">reg</span> is the registry containing the object.
</p>
<p><span class="code">key</span> is the name of the object.
</p>
<p><span class="code">obuf</span> is a pointer to an <span class="code">ei_reg_stat</span> structure,
defined below:
</p>
<div class="example"><pre>
struct ei_reg_stat {
int attr;
int size;
};
</pre></div>
<p>In <span class="code">attr</span> the object's attributes 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).
</p>
<p>The <span class="code">size</span> field 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.
</p>
<p>The function returns 0 and initializes <span class="code">obuf</span> on
success, or returns -1 on failure.</p>
</p></div>
<p><a name="ei_reg_tabstat"><span class="bold_code">int ei_reg_tabstat(reg,obuf)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">struct ei_reg_tabstat *obuf;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Return information about a registry. Using information
returned by this function, you can see whether the size of the
registry is suitable for the amount of data it contains.
</p>
<p><span class="code">reg</span> is the registry to return information about.
</p>
<p><span class="code">obuf</span> is a pointer to an <span class="code">ei_reg_tabstat</span> structure,
defined below:
</p>
<div class="example"><pre>
struct ei_reg_tabstat {
int size;
int nelem;
int npos;
int collisions;
};
</pre></div>
<p>The <span class="code">size</span> field 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.
</p>
<p><span class="code">nelem</span> indicates the number of elements stored in the
registry. It includes objects that are deleted but not purged.
</p>
<p><span class="code">npos</span> indicates the number of unique positions that are
occupied in the registry.
</p>
<p><span class="code">collisions</span> indicates how many elements are sharing
positions in the registry.
</p>
<p>On success, the function returns 0 and <span class="code">obuf</span> is
initialized to contain table statistics. On failure, the function
returns -1.</p>
</p></div>
<p><a name="ei_reg_dump"><span class="bold_code">int ei_reg_dump(fd,reg,mntab,flags)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">int fd;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *mntab;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">int flags;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Dump the contents of a registry to a Mnesia table in an
atomic manner, i.e. either all data will be updated, or none of
it will. If any errors are encountered while backing up
the data, the entire operation is aborted.
</p>
<p><span class="code">fd</span> is an open connection to Erlang.
Mnesia 3.0 or later must be running on the Erlang node.
</p>
<p><span class="code">reg</span> is the registry to back up.
</p>
<p><span class="code">mntab</span> is the name of the Mnesia table where the backed
up data should be placed. If the table does not exist, it will
be created automatically using configurable defaults. See your
Mnesia documentation for information about configuring this
behaviour.
</p>
<p>If <span class="code">flags</span> is 0, the backup will include only those
objects which have been created, modified or deleted since the
last backup or restore (i.e. an incremental backup). After the
backup, any objects that were marked dirty are now clean, and any
objects that had been marked for deletion are deleted.
</p>
<p>Alternatively, setting flags to EI_FORCE will cause a full
backup to be done, and EI_NOPURGE will cause the deleted objects
to be left in the registry afterwards. These can be bitwise ORed
together if both behaviours are desired. If EI_NOPURGE was
specified, you can use <span class="code">ei_reg_purge()</span> to explicitly remove
the deleted items from the registry later.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
<p><a name="ei_reg_restore"><span class="bold_code">int ei_reg_restore(fd,reg,mntab)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">int fd;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">const char *mntab;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>The contents of a Mnesia table are read into the
registry.
</p>
<p><span class="code">fd</span> is an open connection to Erlang.
Mnesia 3.0 or later must be running on the Erlang node.
</p>
<p><span class="code">reg</span> is the registry where the data should be placed.
</p>
<p><span class="code">mntab</span> is the name of the Mnesia table to read data
from.
</p>
<p>Note that only tables of a certain format can be
restored, i.e. those that have been created and backed up to
with <span class="code">ei_reg_dump()</span>. If the registry was not empty before
the operation, then 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
will be overwritten with the new values. If the registry
contains objects that were not in the table, they will be
unchanged by this operation.
</p>
<p>After the restore operation, the entire contents of the
registry is marked as unmodified. Note that this includes any
objects that were modified before the restore and not
overwritten by the restore.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
<p><a name="ei_reg_purge"><span class="bold_code">int ei_reg_purge(reg)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ei_reg *reg;</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Remove all objects marked for deletion. When objects
are deleted with <span class="code">ei_reg_delete()</span> they are not actually
removed from the registry, only marked for later removal. This
is so that on a subsequent backup to Mnesia, the
objects can also be removed from the Mnesia table. If you are
not backing up to Mnesia then you may wish to remove the objects
manually with this function.
</p>
<p><span class="code">reg</span> is a registry containing objects marked for
deletion.
</p>
<p>The function returns 0 on success, or -1 on failure.</p>
</p></div>
</div>
<div class="footer">
<hr>
<p>Copyright © 1998-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
601
