<!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 -- Module_Interface</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/orber-3.6.24.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>orber</strong><br><strong>Reference Manual</strong><br><small>Version 3.6.24</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="any " expanded="false">any<ul>
<li><a href="any.html">
Top of manual page
</a></li>
<li title="create-0"><a href="any.html#create-0">create/0</a></li>
<li title="create-2"><a href="any.html#create-2">create/2</a></li>
<li title="set_typecode-2"><a href="any.html#set_typecode-2">set_typecode/2</a></li>
<li title="get_typecode-1"><a href="any.html#get_typecode-1">get_typecode/1</a></li>
<li title="set_value-2"><a href="any.html#set_value-2">set_value/2</a></li>
<li title="get_value-1"><a href="any.html#get_value-1">get_value/1</a></li>
</ul>
</li>
<li id="no" title="fixed " expanded="false">fixed<ul>
<li><a href="fixed.html">
Top of manual page
</a></li>
<li title="create-3"><a href="fixed.html#create-3">create/3</a></li>
<li title="get_typecode-1"><a href="fixed.html#get_typecode-1">get_typecode/1</a></li>
<li title="add-2"><a href="fixed.html#add-2">add/2</a></li>
<li title="subtract-2"><a href="fixed.html#subtract-2">subtract/2</a></li>
<li title="multiply-2"><a href="fixed.html#multiply-2">multiply/2</a></li>
<li title="divide-2"><a href="fixed.html#divide-2">divide/2</a></li>
<li title="unary_minus-1"><a href="fixed.html#unary_minus-1">unary_minus/1</a></li>
</ul>
</li>
<li id="no" title="corba " expanded="false">corba<ul>
<li><a href="corba.html">
Top of manual page
</a></li>
<li title="create-2"><a href="corba.html#create-2">create/2</a></li>
<li title="create-3"><a href="corba.html#create-3">create/3</a></li>
<li title="create-4"><a href="corba.html#create-4">create/4</a></li>
<li title="create_link-2"><a href="corba.html#create_link-2">create_link/2</a></li>
<li title="create_link-3"><a href="corba.html#create_link-3">create_link/3</a></li>
<li title="create_link-4"><a href="corba.html#create_link-4">create_link/4</a></li>
<li title="dispose-1"><a href="corba.html#dispose-1">dispose/1</a></li>
<li title="create_nil_objref-0"><a href="corba.html#create_nil_objref-0">create_nil_objref/0</a></li>
<li title="create_subobject_key-2"><a href="corba.html#create_subobject_key-2">create_subobject_key/2</a></li>
<li title="get_subobject_key-1"><a href="corba.html#get_subobject_key-1">get_subobject_key/1</a></li>
<li title="get_pid-1"><a href="corba.html#get_pid-1">get_pid/1</a></li>
<li title="raise-1"><a href="corba.html#raise-1">raise/1</a></li>
<li title="reply-2"><a href="corba.html#reply-2">reply/2</a></li>
<li title="resolve_initial_references-1"><a href="corba.html#resolve_initial_references-1">resolve_initial_references/1</a></li>
<li title="resolve_initial_references-2"><a href="corba.html#resolve_initial_references-2">resolve_initial_references/2</a></li>
<li title="add_initial_service-2"><a href="corba.html#add_initial_service-2">add_initial_service/2</a></li>
<li title="remove_initial_service-1"><a href="corba.html#remove_initial_service-1">remove_initial_service/1</a></li>
<li title="list_initial_services-0"><a href="corba.html#list_initial_services-0">list_initial_services/0</a></li>
<li title="resolve_initial_references_remote-2"><a href="corba.html#resolve_initial_references_remote-2">resolve_initial_references_remote/2</a></li>
<li title="resolve_initial_references_remote-3"><a href="corba.html#resolve_initial_references_remote-3">resolve_initial_references_remote/3</a></li>
<li title="list_initial_services_remote-1"><a href="corba.html#list_initial_services_remote-1">list_initial_services_remote/1</a></li>
<li title="list_initial_services_remote-2"><a href="corba.html#list_initial_services_remote-2">list_initial_services_remote/2</a></li>
<li title="object_to_string-1"><a href="corba.html#object_to_string-1">object_to_string/1</a></li>
<li title="string_to_object-1"><a href="corba.html#string_to_object-1">string_to_object/1</a></li>
<li title="string_to_object-2"><a href="corba.html#string_to_object-2">string_to_object/2</a></li>
<li title="print_object-1"><a href="corba.html#print_object-1">print_object/1</a></li>
<li title="add_alternate_iiop_address-3"><a href="corba.html#add_alternate_iiop_address-3">add_alternate_iiop_address/3</a></li>
<li title="orb_init-1"><a href="corba.html#orb_init-1">orb_init/1</a></li>
</ul>
</li>
<li id="no" title="corba_object " expanded="false">corba_object<ul>
<li><a href="corba_object.html">
Top of manual page
</a></li>
<li title="get_interface-1"><a href="corba_object.html#get_interface-1">get_interface/1</a></li>
<li title="is_nil-1"><a href="corba_object.html#is_nil-1">is_nil/1</a></li>
<li title="is_a-2"><a href="corba_object.html#is_a-2">is_a/2</a></li>
<li title="is_a-3"><a href="corba_object.html#is_a-3">is_a/3</a></li>
<li title="is_remote-1"><a href="corba_object.html#is_remote-1">is_remote/1</a></li>
<li title="non_existent-1"><a href="corba_object.html#non_existent-1">non_existent/1</a></li>
<li title="non_existent-2"><a href="corba_object.html#non_existent-2">non_existent/2</a></li>
<li title="not_existent-1"><a href="corba_object.html#not_existent-1">not_existent/1</a></li>
<li title="not_existent-2"><a href="corba_object.html#not_existent-2">not_existent/2</a></li>
<li title="is_equivalent-2"><a href="corba_object.html#is_equivalent-2">is_equivalent/2</a></li>
<li title="hash-2"><a href="corba_object.html#hash-2">hash/2</a></li>
</ul>
</li>
<li id="no" title="orber " expanded="false">orber<ul>
<li><a href="orber.html">
Top of manual page
</a></li>
<li title="start-0"><a href="orber.html#start-0">start/0</a></li>
<li title="start-1"><a href="orber.html#start-1">start/1</a></li>
<li title="jump_start-1"><a href="orber.html#jump_start-1">jump_start/1</a></li>
<li title="stop-0"><a href="orber.html#stop-0">stop/0</a></li>
<li title="info-0"><a href="orber.html#info-0">info/0</a></li>
<li title="info-1"><a href="orber.html#info-1">info/1</a></li>
<li title="exception_info-1"><a href="orber.html#exception_info-1">exception_info/1</a></li>
<li title="is_system_exception-1"><a href="orber.html#is_system_exception-1">is_system_exception/1</a></li>
<li title="get_tables-0"><a href="orber.html#get_tables-0">get_tables/0</a></li>
<li title="get_ORBInitRef-0"><a href="orber.html#get_ORBInitRef-0">get_ORBInitRef/0</a></li>
<li title="get_ORBDefaultInitRef-0"><a href="orber.html#get_ORBDefaultInitRef-0">get_ORBDefaultInitRef/0</a></li>
<li title="domain-0"><a href="orber.html#domain-0">domain/0</a></li>
<li title="iiop_port-0"><a href="orber.html#iiop_port-0">iiop_port/0</a></li>
<li title="iiop_out_ports-0"><a href="orber.html#iiop_out_ports-0">iiop_out_ports/0</a></li>
<li title="iiop_out_ports_random-0"><a href="orber.html#iiop_out_ports_random-0">iiop_out_ports_random/0</a></li>
<li title="iiop_out_ports_attempts-0"><a href="orber.html#iiop_out_ports_attempts-0">iiop_out_ports_attempts/0</a></li>
<li title="iiop_ssl_port-0"><a href="orber.html#iiop_ssl_port-0">iiop_ssl_port/0</a></li>
<li title="iiop_timeout-0"><a href="orber.html#iiop_timeout-0">iiop_timeout/0</a></li>
<li title="iiop_connection_timeout-0"><a href="orber.html#iiop_connection_timeout-0">iiop_connection_timeout/0</a></li>
<li title="iiop_connections-0"><a href="orber.html#iiop_connections-0">iiop_connections/0</a></li>
<li title="iiop_connections-1"><a href="orber.html#iiop_connections-1">iiop_connections/1</a></li>
<li title="iiop_connections_pending-0"><a href="orber.html#iiop_connections_pending-0">iiop_connections_pending/0</a></li>
<li title="iiop_in_connection_timeout-0"><a href="orber.html#iiop_in_connection_timeout-0">iiop_in_connection_timeout/0</a></li>
<li title="iiop_acl-0"><a href="orber.html#iiop_acl-0">iiop_acl/0</a></li>
<li title="activate_audit_trail-0"><a href="orber.html#activate_audit_trail-0">activate_audit_trail/0</a></li>
<li title="activate_audit_trail-1"><a href="orber.html#activate_audit_trail-1">activate_audit_trail/1</a></li>
<li title="deactivate_audit_trail-0"><a href="orber.html#deactivate_audit_trail-0">deactivate_audit_trail/0</a></li>
<li title="add_listen_interface-2"><a href="orber.html#add_listen_interface-2">add_listen_interface/2</a></li>
<li title="add_listen_interface-3"><a href="orber.html#add_listen_interface-3">add_listen_interface/3</a></li>
<li title="add_listen_interface-3"><a href="orber.html#add_listen_interface-3">add_listen_interface/3</a></li>
<li title="remove_listen_interface-1"><a href="orber.html#remove_listen_interface-1">remove_listen_interface/1</a></li>
<li title="close_connection-1"><a href="orber.html#close_connection-1">close_connection/1</a></li>
<li title="close_connection-2"><a href="orber.html#close_connection-2">close_connection/2</a></li>
<li title="secure-0"><a href="orber.html#secure-0">secure/0</a></li>
<li title="ssl_server_options-0"><a href="orber.html#ssl_server_options-0">ssl_server_options/0</a></li>
<li title="ssl_client_options-0"><a href="orber.html#ssl_client_options-0">ssl_client_options/0</a></li>
<li title="set_ssl_client_options-1"><a href="orber.html#set_ssl_client_options-1">set_ssl_client_options/1</a></li>
<li title="objectkeys_gc_time-0"><a href="orber.html#objectkeys_gc_time-0">objectkeys_gc_time/0</a></li>
<li title="orber_nodes-0"><a href="orber.html#orber_nodes-0">orber_nodes/0</a></li>
<li title="install-1"><a href="orber.html#install-1">install/1</a></li>
<li title="install-2"><a href="orber.html#install-2">install/2</a></li>
<li title="uninstall-0"><a href="orber.html#uninstall-0">uninstall/0</a></li>
<li title="add_node-2"><a href="orber.html#add_node-2">add_node/2</a></li>
<li title="remove_node-1"><a href="orber.html#remove_node-1">remove_node/1</a></li>
<li title="configure-2"><a href="orber.html#configure-2">configure/2</a></li>
</ul>
</li>
<li id="no" title="orber_ifr " expanded="false">orber_ifr<ul>
<li><a href="orber_ifr.html">
Top of manual page
</a></li>
<li title="init-2"><a href="orber_ifr.html#init-2">init/2</a></li>
<li title="find_repository-0"><a href="orber_ifr.html#find_repository-0">find_repository/0</a></li>
<li title="get_def_kind-1"><a href="orber_ifr.html#get_def_kind-1">get_def_kind/1</a></li>
<li title="destroy-1"><a href="orber_ifr.html#destroy-1">destroy/1</a></li>
<li title="get_id-1"><a href="orber_ifr.html#get_id-1">get_id/1</a></li>
<li title="set_id-2"><a href="orber_ifr.html#set_id-2">set_id/2</a></li>
<li title="get_name-1"><a href="orber_ifr.html#get_name-1">get_name/1</a></li>
<li title="set_name-2"><a href="orber_ifr.html#set_name-2">set_name/2</a></li>
<li title="get_version-1"><a href="orber_ifr.html#get_version-1">get_version/1</a></li>
<li title="set_version-2"><a href="orber_ifr.html#set_version-2">set_version/2</a></li>
<li title="get_defined_in-1"><a href="orber_ifr.html#get_defined_in-1">get_defined_in/1</a></li>
<li title="get_absolute_name-1"><a href="orber_ifr.html#get_absolute_name-1">get_absolute_name/1</a></li>
<li title="get_containing_repository-1"><a href="orber_ifr.html#get_containing_repository-1">get_containing_repository/1</a></li>
<li title="describe-1"><a href="orber_ifr.html#describe-1">describe/1</a></li>
<li title="move-4"><a href="orber_ifr.html#move-4">move/4</a></li>
<li title="lookup-2"><a href="orber_ifr.html#lookup-2">lookup/2</a></li>
<li title="contents-3"><a href="orber_ifr.html#contents-3">contents/3</a></li>
<li title="lookup_name-5"><a href="orber_ifr.html#lookup_name-5">lookup_name/5</a></li>
<li title="describe_contents-4"><a href="orber_ifr.html#describe_contents-4">describe_contents/4</a></li>
<li title="create_module-4"><a href="orber_ifr.html#create_module-4">create_module/4</a></li>
<li title="create_constant-6"><a href="orber_ifr.html#create_constant-6">create_constant/6</a></li>
<li title="create_struct-5"><a href="orber_ifr.html#create_struct-5">create_struct/5</a></li>
<li title="create_union-6"><a href="orber_ifr.html#create_union-6">create_union/6</a></li>
<li title="create_enum-5"><a href="orber_ifr.html#create_enum-5">create_enum/5</a></li>
<li title="create_alias-5"><a href="orber_ifr.html#create_alias-5">create_alias/5</a></li>
<li title="create_interface-5"><a href="orber_ifr.html#create_interface-5">create_interface/5</a></li>
<li title="create_exception-5"><a href="orber_ifr.html#create_exception-5">create_exception/5</a></li>
<li title="get_type-1"><a href="orber_ifr.html#get_type-1">get_type/1</a></li>
<li title="lookup_id-2"><a href="orber_ifr.html#lookup_id-2">lookup_id/2</a></li>
<li title="get_primitive-2"><a href="orber_ifr.html#get_primitive-2">get_primitive/2</a></li>
<li title="create_string-2"><a href="orber_ifr.html#create_string-2">create_string/2</a></li>
<li title="create_wstring-2"><a href="orber_ifr.html#create_wstring-2">create_wstring/2</a></li>
<li title="create_fixed-3"><a href="orber_ifr.html#create_fixed-3">create_fixed/3</a></li>
<li title="create_sequence-3"><a href="orber_ifr.html#create_sequence-3">create_sequence/3</a></li>
<li title="create_array-3"><a href="orber_ifr.html#create_array-3">create_array/3</a></li>
<li title="create_idltype-2"><a href="orber_ifr.html#create_idltype-2">create_idltype/2</a></li>
<li title="get_type_def-1"><a href="orber_ifr.html#get_type_def-1">get_type_def/1</a></li>
<li title="set_type_def-2"><a href="orber_ifr.html#set_type_def-2">set_type_def/2</a></li>
<li title="get_value-1"><a href="orber_ifr.html#get_value-1">get_value/1</a></li>
<li title="set_value-2"><a href="orber_ifr.html#set_value-2">set_value/2</a></li>
<li title="get_members-1"><a href="orber_ifr.html#get_members-1">get_members/1</a></li>
<li title="set_members-2"><a href="orber_ifr.html#set_members-2">set_members/2</a></li>
<li title="get_discriminator_type-1"><a href="orber_ifr.html#get_discriminator_type-1">get_discriminator_type/1</a></li>
<li title="get_discriminator_type_def-1"><a href="orber_ifr.html#get_discriminator_type_def-1">get_discriminator_type_def/1</a></li>
<li title="set_discriminator_type_def-2"><a href="orber_ifr.html#set_discriminator_type_def-2">set_discriminator_type_def/2</a></li>
<li title="get_original_type_def-1"><a href="orber_ifr.html#get_original_type_def-1">get_original_type_def/1</a></li>
<li title="set_original_type_def-2"><a href="orber_ifr.html#set_original_type_def-2">set_original_type_def/2</a></li>
<li title="get_kind-1"><a href="orber_ifr.html#get_kind-1">get_kind/1</a></li>
<li title="get_bound-1"><a href="orber_ifr.html#get_bound-1">get_bound/1</a></li>
<li title="set_bound-2"><a href="orber_ifr.html#set_bound-2">set_bound/2</a></li>
<li title="get_element_type-1"><a href="orber_ifr.html#get_element_type-1">get_element_type/1</a></li>
<li title="get_element_type_def-1"><a href="orber_ifr.html#get_element_type_def-1">get_element_type_def/1</a></li>
<li title="set_element_type_def-2"><a href="orber_ifr.html#set_element_type_def-2">set_element_type_def/2</a></li>
<li title="get_length-1"><a href="orber_ifr.html#get_length-1">get_length/1</a></li>
<li title="set_length-2"><a href="orber_ifr.html#set_length-2">set_length/2</a></li>
<li title="get_mode-1"><a href="orber_ifr.html#get_mode-1">get_mode/1</a></li>
<li title="set_mode-2"><a href="orber_ifr.html#set_mode-2">set_mode/2</a></li>
<li title="get_result-1"><a href="orber_ifr.html#get_result-1">get_result/1</a></li>
<li title="get_result_def-1"><a href="orber_ifr.html#get_result_def-1">get_result_def/1</a></li>
<li title="set_result_def-2"><a href="orber_ifr.html#set_result_def-2">set_result_def/2</a></li>
<li title="get_params-1"><a href="orber_ifr.html#get_params-1">get_params/1</a></li>
<li title="set_params-2"><a href="orber_ifr.html#set_params-2">set_params/2</a></li>
<li title="get_contexts-1"><a href="orber_ifr.html#get_contexts-1">get_contexts/1</a></li>
<li title="set_contexts-2"><a href="orber_ifr.html#set_contexts-2">set_contexts/2</a></li>
<li title="get_exceptions-1"><a href="orber_ifr.html#get_exceptions-1">get_exceptions/1</a></li>
<li title="set_exceptions-2"><a href="orber_ifr.html#set_exceptions-2">set_exceptions/2</a></li>
<li title="get_base_interfaces-1"><a href="orber_ifr.html#get_base_interfaces-1">get_base_interfaces/1</a></li>
<li title="set_base_interfaces-2"><a href="orber_ifr.html#set_base_interfaces-2">set_base_interfaces/2</a></li>
<li title="is_a-2"><a href="orber_ifr.html#is_a-2">is_a/2</a></li>
<li title="describe_interface-1"><a href="orber_ifr.html#describe_interface-1">describe_interface/1</a></li>
<li title="create_attribute-6"><a href="orber_ifr.html#create_attribute-6">create_attribute/6</a></li>
<li title="create_operation-9"><a href="orber_ifr.html#create_operation-9">create_operation/9</a></li>
</ul>
</li>
<li id="no" title="orber_tc " expanded="false">orber_tc<ul>
<li><a href="orber_tc.html">
Top of manual page
</a></li>
<li title="null-0"><a href="orber_tc.html#null-0">null/0</a></li>
<li title="void-0"><a href="orber_tc.html#void-0">void/0</a></li>
<li title="short-0"><a href="orber_tc.html#short-0">short/0</a></li>
<li title="unsigned_short-0"><a href="orber_tc.html#unsigned_short-0">unsigned_short/0</a></li>
<li title="long-0"><a href="orber_tc.html#long-0">long/0</a></li>
<li title="unsigned_long-0"><a href="orber_tc.html#unsigned_long-0">unsigned_long/0</a></li>
<li title="long_long-0"><a href="orber_tc.html#long_long-0">long_long/0</a></li>
<li title="unsigned_long_long-0"><a href="orber_tc.html#unsigned_long_long-0">unsigned_long_long/0</a></li>
<li title="wchar-0"><a href="orber_tc.html#wchar-0">wchar/0</a></li>
<li title="float-0"><a href="orber_tc.html#float-0">float/0</a></li>
<li title="double-0"><a href="orber_tc.html#double-0">double/0</a></li>
<li title="boolean-0"><a href="orber_tc.html#boolean-0">boolean/0</a></li>
<li title="char-0"><a href="orber_tc.html#char-0">char/0</a></li>
<li title="octet-0"><a href="orber_tc.html#octet-0">octet/0</a></li>
<li title="any-0"><a href="orber_tc.html#any-0">any/0</a></li>
<li title="typecode-0"><a href="orber_tc.html#typecode-0">typecode/0</a></li>
<li title="principal-0"><a href="orber_tc.html#principal-0">principal/0</a></li>
<li title="object_reference-2"><a href="orber_tc.html#object_reference-2">object_reference/2</a></li>
<li title="struct-3"><a href="orber_tc.html#struct-3">struct/3</a></li>
<li title="union-5"><a href="orber_tc.html#union-5">union/5</a></li>
<li title="enum-3"><a href="orber_tc.html#enum-3">enum/3</a></li>
<li title="string-1"><a href="orber_tc.html#string-1">string/1</a></li>
<li title="wstring-1"><a href="orber_tc.html#wstring-1">wstring/1</a></li>
<li title="fixed-2"><a href="orber_tc.html#fixed-2">fixed/2</a></li>
<li title="sequence-2"><a href="orber_tc.html#sequence-2">sequence/2</a></li>
<li title="array-2"><a href="orber_tc.html#array-2">array/2</a></li>
<li title="alias-3"><a href="orber_tc.html#alias-3">alias/3</a></li>
<li title="exception-3"><a href="orber_tc.html#exception-3">exception/3</a></li>
<li title="get_tc-1"><a href="orber_tc.html#get_tc-1">get_tc/1</a></li>
<li title="get_tc-1"><a href="orber_tc.html#get_tc-1">get_tc/1</a></li>
<li title="check_tc-1"><a href="orber_tc.html#check_tc-1">check_tc/1</a></li>
</ul>
</li>
<li id="no" title="orber_acl " expanded="false">orber_acl<ul>
<li><a href="orber_acl.html">
Top of manual page
</a></li>
<li title="match-2"><a href="orber_acl.html#match-2">match/2</a></li>
<li title="match-3"><a href="orber_acl.html#match-3">match/3</a></li>
<li title="verify-3"><a href="orber_acl.html#verify-3">verify/3</a></li>
<li title="range-2"><a href="orber_acl.html#range-2">range/2</a></li>
</ul>
</li>
<li title="CosNaming"><a href="CosNaming.html">CosNaming</a></li>
<li id="no" title="CosNaming_NamingContext " expanded="false">CosNaming_NamingContext<ul>
<li><a href="CosNaming_NamingContext.html">
Top of manual page
</a></li>
<li title="bind-3"><a href="CosNaming_NamingContext.html#bind-3">bind/3</a></li>
<li title="rebind-3"><a href="CosNaming_NamingContext.html#rebind-3">rebind/3</a></li>
<li title="bind_context-3"><a href="CosNaming_NamingContext.html#bind_context-3">bind_context/3</a></li>
<li title="rebind_context-3"><a href="CosNaming_NamingContext.html#rebind_context-3">rebind_context/3</a></li>
<li title="resolve-2"><a href="CosNaming_NamingContext.html#resolve-2">resolve/2</a></li>
<li title="unbind-2"><a href="CosNaming_NamingContext.html#unbind-2">unbind/2</a></li>
<li title="new_context-1"><a href="CosNaming_NamingContext.html#new_context-1">new_context/1</a></li>
<li title="bind_new_context-2"><a href="CosNaming_NamingContext.html#bind_new_context-2">bind_new_context/2</a></li>
<li title="destroy-1"><a href="CosNaming_NamingContext.html#destroy-1">destroy/1</a></li>
<li title="list-2"><a href="CosNaming_NamingContext.html#list-2">list/2</a></li>
</ul>
</li>
<li id="no" title="CosNaming_NamingContextExt " expanded="false">CosNaming_NamingContextExt<ul>
<li><a href="CosNaming_NamingContextExt.html">
Top of manual page
</a></li>
<li title="to_string-2"><a href="CosNaming_NamingContextExt.html#to_string-2">to_string/2</a></li>
<li title="to_name-2"><a href="CosNaming_NamingContextExt.html#to_name-2">to_name/2</a></li>
<li title="to_url-3"><a href="CosNaming_NamingContextExt.html#to_url-3">to_url/3</a></li>
<li title="resolve_str-2"><a href="CosNaming_NamingContextExt.html#resolve_str-2">resolve_str/2</a></li>
</ul>
</li>
<li id="no" title="CosNaming_BindingIterator " expanded="false">CosNaming_BindingIterator<ul>
<li><a href="CosNaming_BindingIterator.html">
Top of manual page
</a></li>
<li title="next_one-1"><a href="CosNaming_BindingIterator.html#next_one-1">next_one/1</a></li>
<li title="next_n-2"><a href="CosNaming_BindingIterator.html#next_n-2">next_n/2</a></li>
<li title="destroy-1"><a href="CosNaming_BindingIterator.html#destroy-1">destroy/1</a></li>
</ul>
</li>
<li id="no" title="lname " expanded="false">lname<ul>
<li><a href="lname.html">
Top of manual page
</a></li>
<li title="create-0"><a href="lname.html#create-0">create/0</a></li>
<li title="insert_component-3"><a href="lname.html#insert_component-3">insert_component/3</a></li>
<li title="get_component-2"><a href="lname.html#get_component-2">get_component/2</a></li>
<li title="delete_component-2"><a href="lname.html#delete_component-2">delete_component/2</a></li>
<li title="num_component-1"><a href="lname.html#num_component-1">num_component/1</a></li>
<li title="equal-2"><a href="lname.html#equal-2">equal/2</a></li>
<li title="less_than-2"><a href="lname.html#less_than-2">less_than/2</a></li>
<li title="to_idl_form-1"><a href="lname.html#to_idl_form-1">to_idl_form/1</a></li>
<li title="from_idl_form-1"><a href="lname.html#from_idl_form-1">from_idl_form/1</a></li>
</ul>
</li>
<li id="no" title="lname_component " expanded="false">lname_component<ul>
<li><a href="lname_component.html">
Top of manual page
</a></li>
<li title="create-0"><a href="lname_component.html#create-0">create/0</a></li>
<li title="get_id-1"><a href="lname_component.html#get_id-1">get_id/1</a></li>
<li title="set_id-2"><a href="lname_component.html#set_id-2">set_id/2</a></li>
<li title="get_kind-1"><a href="lname_component.html#get_kind-1">get_kind/1</a></li>
<li title="set_kind-2"><a href="lname_component.html#set_kind-2">set_kind/2</a></li>
</ul>
</li>
<li id="loadscrollpos" title="Module_Interface " expanded="true">Module_Interface<ul>
<li><a href="Module_Interface.html">
Top of manual page
</a></li>
<li title="Module_Interface:typeID-0"><a href="Module_Interface.html#Module_Interface:typeID-0">Module_Interface:typeID/0</a></li>
<li title="Module_Interface:oe_create-0"><a href="Module_Interface.html#Module_Interface:oe_create-0">Module_Interface:oe_create/0</a></li>
<li title="Module_Interface:oe_create_link-0"><a href="Module_Interface.html#Module_Interface:oe_create_link-0">Module_Interface:oe_create_link/0</a></li>
<li title="Module_Interface:oe_create-1"><a href="Module_Interface.html#Module_Interface:oe_create-1">Module_Interface:oe_create/1</a></li>
<li title="Module_Interface:oe_create_link-1"><a href="Module_Interface.html#Module_Interface:oe_create_link-1">Module_Interface:oe_create_link/1</a></li>
<li title="Module_Interface:oe_create-2"><a href="Module_Interface.html#Module_Interface:oe_create-2">Module_Interface:oe_create/2</a></li>
<li title="Module_Interface:oe_create_link-2"><a href="Module_Interface.html#Module_Interface:oe_create_link-2">Module_Interface:oe_create_link/2</a></li>
<li title="Module_Interface:own_functions-4"><a href="Module_Interface.html#Module_Interface:own_functions-4">Module_Interface:own_functions/4</a></li>
<li title="Module_Interface:own_functions-5"><a href="Module_Interface.html#Module_Interface:own_functions-5">Module_Interface:own_functions/5</a></li>
<li title="Module_Interface_impl:init-1"><a href="Module_Interface.html#Module_Interface_impl:init-1">Module_Interface_impl:init/1</a></li>
<li title="Module_Interface_impl:terminate-2"><a href="Module_Interface.html#Module_Interface_impl:terminate-2">Module_Interface_impl:terminate/2</a></li>
<li title="Module_Interface_impl:code_change-3"><a href="Module_Interface.html#Module_Interface_impl:code_change-3">Module_Interface_impl:code_change/3</a></li>
<li title="Module_Interface_impl:handle_info-2"><a href="Module_Interface.html#Module_Interface_impl:handle_info-2">Module_Interface_impl:handle_info/2</a></li>
<li title="Module_Interface_impl:own_functions-4"><a href="Module_Interface.html#Module_Interface_impl:own_functions-4">Module_Interface_impl:own_functions/4</a></li>
<li title="Module_Interface_impl:own_functions-5"><a href="Module_Interface.html#Module_Interface_impl:own_functions-5">Module_Interface_impl:own_functions/5</a></li>
<li title="Module_Interface_impl:own_functions-6"><a href="Module_Interface.html#Module_Interface_impl:own_functions-6">Module_Interface_impl:own_functions/6</a></li>
<li title="Module_Interface_impl:own_functions-5"><a href="Module_Interface.html#Module_Interface_impl:own_functions-5">Module_Interface_impl:own_functions/5</a></li>
<li title="Module_Interface_impl:own_functions-4"><a href="Module_Interface.html#Module_Interface_impl:own_functions-4">Module_Interface_impl:own_functions/4</a></li>
<li title="Module_Interface_impl:own_functions-5"><a href="Module_Interface.html#Module_Interface_impl:own_functions-5">Module_Interface_impl:own_functions/5</a></li>
</ul>
</li>
<li id="no" title="interceptors " expanded="false">interceptors<ul>
<li><a href="interceptors.html">
Top of manual page
</a></li>
<li title="new_in_connection-3"><a href="interceptors.html#new_in_connection-3">new_in_connection/3</a></li>
<li title="new_in_connection-5"><a href="interceptors.html#new_in_connection-5">new_in_connection/5</a></li>
<li title="new_out_connection-3"><a href="interceptors.html#new_out_connection-3">new_out_connection/3</a></li>
<li title="new_out_connection-5"><a href="interceptors.html#new_out_connection-5">new_out_connection/5</a></li>
<li title="closed_in_connection-1"><a href="interceptors.html#closed_in_connection-1">closed_in_connection/1</a></li>
<li title="closed_out_connection-1"><a href="interceptors.html#closed_out_connection-1">closed_out_connection/1</a></li>
<li title="in_reply-6"><a href="interceptors.html#in_reply-6">in_reply/6</a></li>
<li title="in_reply_encoded-6"><a href="interceptors.html#in_reply_encoded-6">in_reply_encoded/6</a></li>
<li title="in_request-6"><a href="interceptors.html#in_request-6">in_request/6</a></li>
<li title="in_request_encoded-6"><a href="interceptors.html#in_request_encoded-6">in_request_encoded/6</a></li>
<li title="out_reply-6"><a href="interceptors.html#out_reply-6">out_reply/6</a></li>
<li title="out_reply_encoded-6"><a href="interceptors.html#out_reply_encoded-6">out_reply_encoded/6</a></li>
<li title="out_request-6"><a href="interceptors.html#out_request-6">out_request/6</a></li>
<li title="out_request_encoded-6"><a href="interceptors.html#out_request_encoded-6">out_request_encoded/6</a></li>
</ul>
</li>
<li id="no" title="orber_diagnostics " expanded="false">orber_diagnostics<ul>
<li><a href="orber_diagnostics.html">
Top of manual page
</a></li>
<li title="nameservice-0"><a href="orber_diagnostics.html#nameservice-0">nameservice/0</a></li>
<li title="nameservice-1"><a href="orber_diagnostics.html#nameservice-1">nameservice/1</a></li>
<li title="missing_modules-0"><a href="orber_diagnostics.html#missing_modules-0">missing_modules/0</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><h1>Module_Interface</h1></center>
<h3>MODULE</h3>
<div class="REFBODY">Module_Interface</div>
<h3>MODULE SUMMARY</h3>
<div class="REFBODY">Orber generated stubs/skeletons.</div>
<h3>DESCRIPTION</h3>
<div class="REFBODY"><p>
<p>This module contains the stub/skeleton functions generated by IC.</p>
<p>Starting a Orber server can be done in three ways:</p>
<ul>
<li>Normal - when the server dies Orber forgets all knowledge of the server.</li>
<li>Supervisor child - adding the configuration parameter <span class="code">{sup_child, true}</span>
the <span class="code">oe_create_link/2</span> function returns <span class="code">{ok, Pid, ObjRef}</span> which
can be handled by the application <strong>supervisor/stdlib-1.7</strong> or later. </li>
<li>Persistent object reference - adding the configuration parameters <span class="code">{persistent, true}</span>
and <span class="code">{regname, {global, term()}}</span> Orber will remember the object reference until the
server terminates with reason <strong>normal</strong> or <strong>shutdown</strong>. Hence,
if the server is started as a <strong>transient</strong> supervisor child we do not
receive a 'OBJECT_NOT_EXIST' exception when it has crashed and is being restarted.</li>
</ul>
<p>The Orber stub can be used to start a <span class="code">pseudo object</span>, which will create a non-server implementation.
A pseudo object introduce some limitations:</p>
<ul>
<li>The functions <span class="code">oe_create_link/2</span> is equal to <span class="code">oe_create/2</span>, i.e.,
no link can or will be created.</li>
<li>The <span class="code">BIF:s self()</span> and <span class="code">process_flag(trap_exit,true)</span> behaves incorrectly.</li>
<li>The <span class="code">IC</span> option <span class="code">{{impl, "M::I"}, "other_impl"}</span> has no effect. The call-back
functions must be implemented in a file called <span class="code">M_I_impl.erl</span>
</li>
<li>The <span class="code">IC</span> option <span class="code">from</span> has no effect. </li>
<li>The call-back functions must be implemented as if the <span class="code">IC</span> option
<span class="code">{this, "M::I"}</span> was used.</li>
<li>Server <span class="code">State</span> changes have no effect. The user can provide information via
the <span class="code">Env</span> start parameter and the State returned from <span class="code">init/2</span> will be the State
passed in following invocations.</li>
<li>If a call-back function replies with the <span class="code">Timeout</span> parameter set it have no effect.</li>
<li>Operations defined as <span class="code">oneway</span> are blocking until the operation replies.</li>
<li>The option <span class="code">{pseudo, true}</span> overrides all other start options.</li>
<li>Only the functions, besides own definitions, <span class="code">init/2</span> (called via oe_create*/2) and
<span class="code">terminate/2</span> (called via corba:dispose/1) must be implemented.</li>
</ul>
<p>By adopting the rules for <span class="code">pseudo</span> objects described above we can use <span class="code">oe_create/2</span>
to create <span class="code">server</span> or <span class="code">pseudo</span> objects, by excluding or including the
option <span class="code">{pseudo, true}</span>, without changing the call-back module.
</p>
<p>If you start a object without <span class="code">{regname, RegName}</span> it can only be accessed through the returned object key.
Started with a <span class="code">{regname, RegName}</span> the name is registered locally or globally.
</p>
<div class="warning">
<div class="label">Warning</div>
<div class="content"><p>
<p>To avoid flooding Orber with old object references start erlang using the flag
<strong>-orber objectkeys_gc_time Time</strong>, which will remove all object references
related to servers being dead for Time seconds. To avoid extra overhead, i.e., performing
garbage collect if no persistent objects are started, the objectkeys_gc_time default value
is <strong>infinity</strong>. For more information, see the orber and corba documentation.</p>
</p></div>
</div>
</p></div>
<h3>EXPORTS</h3>
<p><a name="Module_Interface:typeID-0"><span class="bold_code">Module_Interface:typeID() -> TypeId</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">TypeId = string(), e.g., "IDL:Module/Interface:1.0"</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Returns the Type ID related to this stub/skeleton</p>
</p></div>
<p><a name="Module_Interface:oe_create-0"><span class="bold_code">Module_Interface:oe_create() -> ObjRef</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ObjRef = #object reference</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Start a Orber server.</p>
</p></div>
<p><a name="Module_Interface:oe_create_link-0"><span class="bold_code">Module_Interface:oe_create_link() -> ObjRef</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ObjRef = #object reference</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Start a linked Orber server.</p>
</p></div>
<p><a name="Module_Interface:oe_create-1"><span class="bold_code">Module_Interface:oe_create(Env) -> ObjRef</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Env = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ObjRef = #object reference</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Start a Orber server passing Env to <span class="code">init/1</span>.</p>
</p></div>
<p><a name="Module_Interface:oe_create_link-1"><span class="bold_code">Module_Interface:oe_create_link(Env) -> ObjRef</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Env = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ObjRef = #object reference</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Start a linked Orber server passing Env to <span class="code">init/1</span>.</p>
</p></div>
<p><a name="Module_Interface:oe_create-2"><span class="bold_code">Module_Interface:oe_create(Env, Options) -> ObjRef</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Env = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ObjRef = #object reference</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Options = [{sup_child, false} | {persistent, Bool} | {regname, RegName} | {pseudo, Bool} | {local_typecheck, Bool} | {survive_exit, Bool} | {create_options, [CreateOpts]}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Bool = true | false</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">RegName = {global, term()} | {local, atom()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CreateOpts = {debug, [Dbg]} | {timeout, Time}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Dbg = trace | log | statistics | {log_to_file, FileName}</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Start a Orber server passing Env to <span class="code">init/1</span>.</p>
<p>If the option <span class="code">{pseudo, true}</span> is used, all other options are overridden.
As default, this option is set to false.</p>
<p>This function cannot be used for starting a server as supervisor child.
If started as <span class="code">persistent</span>, the options <span class="code">[{persistent, true}, {regname, {global, term()}}]</span> must be used and
Orber will only forget the object reference if it terminates with reason <strong>normal</strong> or <strong>shutdown</strong>.</p>
<p>The option <span class="code">{local_typecheck, boolean()}</span>, which overrides the
<span class="bold_code"><a href="ch_install.html#flags">Local Typechecking</a></span>
environment flag, turns on or off typechecking. If activated,
parameters, replies and raised exceptions will be checked to ensure that
the data is correct, when invoking operations on CORBA Objects within
the same Orber domain. Due to the extra overhead, this option
<strong>MAY ONLY</strong> be used during testing and development.</p>
<p><span class="code">{survive_exit, boolean()}</span> overrides the
<span class="bold_code"><a href="ch_install.html#flags">EXIT Tolerance</a></span>
environment flag. If activated, the server will not terminate, even though
the call-back module returns EXIT.</p>
<p><span class="code">Time</span> specifies how long time, in milliseconds, the server is allowed to
spend initializing. For more information about the <span class="code">Dbg</span> options,
see the <span class="code">sys</span> module.</p>
</p></div>
<p><a name="Module_Interface:oe_create_link-2"><span class="bold_code">Module_Interface:oe_create_link(Env, Options) -> Return</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Env = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Return = ObjRef | {ok, Pid, ObjRef}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ObjRef = #object reference</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Options = [{sup_child, Bool} | {persistent, Bool} | {regname, RegName} | {pseudo, Bool} | {local_typecheck, Bool} | {survive_exit, Bool} | {create_options, [CreateOpts]}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Bool = true | false</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">RegName = {global, term()} | {local, atom()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CreateOpts = {debug, [Dbg]} | {timeout, Time}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Dbg = trace | log | statistics | {log_to_file, FileName}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code"></span><br>
</div>
<div class="REFTYPES">
<span class="bold_code"></span><br>
</div>
<div class="REFTYPES">
<span class="bold_code"></span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Start a linked Orber server passing Env to <span class="code">init/1</span>.</p>
<p>If the option <span class="code">{pseudo, true}</span> is used, all other options are overridden and no link will be created.
As default, this option is set to false.</p>
<p>This function can be used for starting a server as persistent or supervisor child. At the moment
<span class="code">[{persistent, true}, {regname, {global, term()}}]</span> must be used to start
a server as persistent, i.e., if a server died and is in the process of being restarted
a call to the server will not raise <span class="code">'OBJECT_NOT_EXIST'</span> exception.
Orber will only forget the object reference if it terminates with reason <strong>normal</strong> or <strong>shutdown</strong>,
hence, the server must be started as <strong>transient</strong> (for more information see the
supervisor documentation).</p>
<p>The options <span class="code">{local_typecheck, boolean()}</span> and <span class="code">{survive_exit, boolean()}</span>
behaves in the same way as for <span class="code">oe_create/2</span>.</p>
<p><span class="code">Time</span> specifies how long time, in milliseconds, the server is allowed to
spend initializing. For more information about the <span class="code">Dbg</span> options,
see the <span class="code">sys</span> module.</p>
</p></div>
<p><a name="Module_Interface:own_functions-4"><span class="bold_code">Module_Interface:own_functions(ObjRef, Arg1, ..., ArgN) -> Reply</span></a><br><a name="Module_Interface:own_functions-5"><span class="bold_code">Module_Interface:own_functions(ObjRef, Options, Arg1, ..., ArgN) -> Reply</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">ObjRef = #object reference</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Options = [Option] | Timeout</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Option = {timeout, Timeout} | {context, [Context]}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = infinity | integer(milliseconds)</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Context = #'IOP_ServiceContext'{context_id = CtxId, context_data = CtxData}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CtxId = ?ORBER_GENERIC_CTX_ID</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CtxData = {interface, Interface} | {userspecific, term()} | {configuration, Options}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Interface = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Options = [{Key, Value}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = ssl_client_verify | ssl_client_depth | ssl_client_certfile | ssl_client_cacertfile |
ssl_client_password | ssl_client_keyfile | ssl_client_ciphers | ssl_client_cachetimeout</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Value = allowed value associated with the given key</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ArgX = specified in the IDL-code.</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reply = specified in the IDL-code.</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>The default value for the <span class="code">Timeout</span> option is <span class="code">infinity</span>.
IPv4 or IPv6 addresses are accepted as local Interface.</p>
<p>The <strong>configuration</strong> context is used to override the global
SSL client side
<span class="bold_code"><a href="ch_install.html#config">configuration</a></span>.</p>
<p>To gain access to <span class="code">#'IOP_ServiceContext'{}</span> record and the
<span class="code">?ORBER_GENERIC_CTX_ID</span> macro, you must add
<span class="code">-include_lib("orber/include/corba.hrl").</span> to your module.</p>
</p></div>
<h3><a name="id95333">CALLBACK FUNCTIONS</a></h3>
<div class="REFBODY">
<p>The following functions should be exported from a <span class="code">CORBA</span>
callback module. Note, a complete template of the call-back module can
be generated automatically by compiling the IDL-file with the IC option
<span class="code">{be,erl_template}</span>. One should also add
the same compile options, for example <span class="code">this</span> or <span class="code">from</span>,
used when generating the stub/skeleton modules.</p>
</div>
<h3>EXPORTS</h3>
<p><a name="Module_Interface_impl:init-1"><span class="bold_code">Module_Interface_impl:init(Env) -> CallReply</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Env = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CallReply = {ok, State} | {ok, State, Timeout} | ignore | {stop, StopReason}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">State = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = int() >= 0 | infinity</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">StopReason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Whenever a new server is started, <strong>init/1</strong> is the first function called in the specified call-back module.</p>
</p></div>
<p><a name="Module_Interface_impl:terminate-2"><span class="bold_code">Module_Interface_impl:terminate(Reason, State) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">State = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This call-back function is called whenever the server is about to terminate.</p>
</p></div>
<p><a name="Module_Interface_impl:code_change-3"><span class="bold_code">Module_Interface_impl:code_change(OldVsn, State, Extra) -> CallReply</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">OldVsn = undefined | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">State = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Extra = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CallReply = {ok, NewState}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">NewState = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Update the internal <span class="code">State</span>.</p>
</p></div>
<p><a name="Module_Interface_impl:handle_info-2"><span class="bold_code">Module_Interface_impl:handle_info(Info, State) -> CallReply</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Info = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">State = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CallReply = {noreply, State} | {noreply, State, Timeout} | {stop, StopReason, State}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = int() >= 0 | infinity</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">StopReason = normal | shutdown | term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>If the configuration parameter <strong>{{handle_info, "Module::Interface"}, true}</strong>
is passed to IC and <strong>process_flag(trap_exit,true)</strong> is set in the <strong>init()</strong>
call-back this function must be exported. </p>
<div class="note">
<div class="label">Note</div>
<div class="content"><p>
<p>To be able to handle the <span class="code">Timeout</span> option in <span class="code">CallReply</span> in the call-back
module the configuration parameter <strong>{{handle_info, "Module::Interface"}, true}</strong> must
be passed to IC. </p>
</p></div>
</div>
</p></div>
<p><a name="Module_Interface_impl:own_functions-4"><span class="bold_code">Module_Interface_impl:own_functions(State, Arg1, ..., ArgN) -> CallReply</span></a><br><a name="Module_Interface_impl:own_functions-5"><span class="bold_code">Module_Interface_impl:own_functions(This, State, Arg1, ..., ArgN) -> CallReply</span></a><br><a name="Module_Interface_impl:own_functions-6"><span class="bold_code">Module_Interface_impl:own_functions(This, From, State, Arg1, ..., ArgN) -> ExtCallReply</span></a><br><a name="Module_Interface_impl:own_functions-5"><span class="bold_code">Module_Interface_impl:own_functions(From, State, Arg1, ..., ArgN) -> ExtCallReply</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">This = the servers #object reference</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">State = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ArgX = specified in the IDL-code.</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CallReply = {reply, Reply, State} | {reply, Reply, State, Timeout} | {stop, StopReason, Reply, State} | {stop, StopReason, State} | corba:raise(Exception)</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtCallReply = CallReply | corba:reply(From, Reply), {noreply, State} | corba:reply(From, Reply), {noreply, State, Timeout}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reply = specified in the IDL-code.</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = int() >= 0 | infinity</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">StopReason = normal | shutdown | term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>All two-way functions must return one of the listed replies or raise any of
the exceptions listed in the IDL code (i.e. raises(...)).
If the IC compile options <strong>this</strong> and/or <strong>from</strong> are used,
the implementation must accept the <strong>This</strong> and/or <strong>From</strong>
parameters.</p>
</p></div>
<p><a name="Module_Interface_impl:own_functions-4"><span class="bold_code">Module_Interface_impl:own_functions(State, Arg1, ..., ArgN) -> CastReply</span></a><br><a name="Module_Interface_impl:own_functions-5"><span class="bold_code">Module_Interface_impl:own_functions(This, State, Arg1, ..., ArgN) -> CastReply</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">This = the servers #object reference</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">State = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CastReply = {noreply, State} | {noreply, State, Timeout} | {stop, StopReason, State}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ArgX = specified in the IDL-code.</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reply = specified in the IDL-code.</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = int() >= 0 | infinity</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">StopReason = normal | shutdown | term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>All one-way functions must return one of the listed replies.
If the IC compile option <strong>this</strong> is used,
the implementation must accept the <strong>This</strong> parameter.</p>
</p></div>
</div>
<div class="footer">
<hr>
<p>Copyright © 1997-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
