<!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 -- orber</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="loadscrollpos" title="orber " expanded="true">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="no" title="Module_Interface " expanded="false">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>orber</h1></center>
<h3>MODULE</h3>
<div class="REFBODY">orber</div>
<h3>MODULE SUMMARY</h3>
<div class="REFBODY">The main module of the Orber application</div>
<h3>DESCRIPTION</h3>
<div class="REFBODY"><p>
<p>This module contains the functions for starting and stopping the
application. It also has some utility functions to get some of
the configuration information from running application.</p>
</p></div>
<h3>EXPORTS</h3>
<p><a name="start-0"><span class="bold_code">start() -> ok</span></a><br><a name="start-1"><span class="bold_code">start(Type) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Type = temporary | permanent</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Starts the Orber application (it also starts mnesia if it is not running).
Which <span class="code">Type</span> parameter is supplied determines the behavior. If not
supplied Orber is started as <span class="code">temporary</span>.
See the Reference Manual <strong>application(3)</strong> for further information. </p>
</p></div>
<p><a name="jump_start-1"><span class="bold_code">jump_start(Attributes) -> ok | {'EXIT', Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Attributes = Port | Options</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Port = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Options = [{Key, Value}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = any key listed in the configuration chapter</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Value = allowed value associated with the given key</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Installs and starts the Orber and the Mnesia applications with the configuration
parameters <span class="code">domain</span> and <span class="code">iiop_port</span> set to <span class="code">"IP-number:Port"</span>
and the supplied Port respectively. Theses settings are in most cases
sufficient to ensure that no clash with any other Orber instance occur.
If this operation fails, check if the listen port (iiop_port) is already
in use. This function <strong>MAY ONLY</strong> be used during development and
tests; how Orber is configured when using this operation may change
at any time without warning.</p>
</p></div>
<p><a name="stop-0"><span class="bold_code">stop() -> ok</span></a><br></p>
<div class="REFBODY"><p>
<p>Stops the Orber application.</p>
</p></div>
<p><a name="info-0"><span class="bold_code">info() -> ok</span></a><br><a name="info-1"><span class="bold_code">info(IoType) -> ok | {'EXIT', Reason} | string()</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">IoType = info_msg | string | io | {io, IoDevice}</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Generates an Info Report, which contain Orber's configuration settings.
If no <span class="code">IoType</span> is supplied, <span class="code">info_msg</span> is used (see the
error_logger documentation). When the atom string is supplied this
function will return a flat list. For <span class="code">io</span> and <span class="code">{io, IoDevice}</span>,
<span class="code">io:format/1</span> and <span class="code">io:format/3</span> is used respectively.</p>
</p></div>
<p><a name="exception_info-1"><span class="bold_code">exception_info(Exception) -> {ok, string()} | {error, Reason}</span></a><br></p>
<div class="REFBODY"><p>
<p>Returns a printable string, which describes the supplied exception
in greater detail. Note, this function is mainly intended for
system exceptions.</p>
</p></div>
<p><a name="is_system_exception-1"><span class="bold_code">is_system_exception(Exception) -> true | false</span></a><br></p>
<div class="REFBODY"><p>
<p>Returns true if the supplied exception is a system defined
exception, otherwise false.</p>
</p></div>
<p><a name="get_tables-0"><span class="bold_code">get_tables() -> [Tables]</span></a><br></p>
<div class="REFBODY"><p>
<p>Returns a list of the Orber specific Mnesia tables. This list is
required to restore Mnesia if it has been partitioned.</p>
</p></div>
<p><a name="get_ORBInitRef-0"><span class="bold_code">get_ORBInitRef() -> string() | undefined</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns undefined if we will resolve references locally,
otherwise a string describing which host we will contact if the Key given
to <span class="code">corba:resolve_initial_references/1</span> matches the Key set
in this configuration variable. For more information
see the user's guide.</p>
</p></div>
<p><a name="get_ORBDefaultInitRef-0"><span class="bold_code">get_ORBDefaultInitRef() -> string() | undefined</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns undefined if we will resolve references locally,
otherwise a string describing which host, or hosts, from which we
will try to resolve the Key given to
<span class="code">corba:resolve_initial_references/1</span>. For more information
see the user's guide.</p>
</p></div>
<p><a name="domain-0"><span class="bold_code">domain() -> string()</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the domain name of the current Orber domain
as a string.</p>
</p></div>
<p><a name="iiop_port-0"><span class="bold_code">iiop_port() -> int()</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the port-number, which is used by the IIOP
protocol. It can be configured by setting the application variable
<strong>iiop_port</strong>, if it is not set it will have the default number
4001.</p>
</p></div>
<p><a name="iiop_out_ports-0"><span class="bold_code">iiop_out_ports() -> 0 | {Min, Max}</span></a><br></p>
<div class="REFBODY"><p>
<p>The return value of this operation is what the configuration
parameter <span class="bold_code"><a href="ch_install.html#config">iiop_out_ports</a></span>
has been set to.</p>
</p></div>
<p><a name="iiop_out_ports_random-0"><span class="bold_code">iiop_out_ports_random() -> true | false</span></a><br></p>
<div class="REFBODY"><p>
<p>Return the value of the configuration parameter
<span class="bold_code"><a href="ch_install.html#config">iiop_out_ports_random</a></span>.</p>
</p></div>
<p><a name="iiop_out_ports_attempts-0"><span class="bold_code">iiop_out_ports_attempts() -> int()</span></a><br></p>
<div class="REFBODY"><p>
<p>Return the value of the configuration parameter
<span class="bold_code"><a href="ch_install.html#config">iiop_out_ports_attempts</a></span>.</p>
</p></div>
<p><a name="iiop_ssl_port-0"><span class="bold_code">iiop_ssl_port() -> int()</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the port-number, which is used by the secure IIOP
protocol. It can be configured by setting the application variable
<strong>iiop_ssl_port</strong>, if it is not set it will have the default number
4002 if Orber is to configured to run in secure mode. Otherwise it returns -1.</p>
</p></div>
<p><a name="iiop_timeout-0"><span class="bold_code">iiop_timeout() -> int() (milliseconds)</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the timeout value after which outgoing IIOP requests terminate.
It can be configured by setting the application variable
<strong>iiop_timeout TimeVal (seconds)</strong>, if it is not set it will have the default value
<strong>infinity</strong>. If a request times out a system exception, e.g.
<strong>TIMEOUT</strong>, is raised.</p>
<p>Note: the iiop_timeout configuration parameter (TimeVal) may only range between 0 and 1000000 seconds.
Otherwise, the default value is used.</p>
<p>Note: Earlier IC versions required that the compile option <span class="code">{timeout,"module::interface"}</span>,
was used, which allow the user to add an extra timeout parameter, e.g.,
<span class="code">module_interface:function(ObjRef, Timeout, ... Arguments ...)</span> or
<span class="code">module_interface:function(ObjRef, [{timeout, Timeout}], ... Arguments ...)</span>,
instead of <span class="code">module_interface:function(ObjRef, ... Arguments ...)</span>.
This is no longer the case and if the extra Timeout is used,
argument will override the configuration parameter <span class="code">iiop_timeout</span>.
It is, however, not possible
to use <span class="code">infinity</span> to override the Timeout parameter. The Timeout
option is also valid for objects which resides within the same Orber domain.</p>
</p></div>
<p><a name="iiop_connection_timeout-0"><span class="bold_code">iiop_connection_timeout() -> int() (milliseconds)</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the timeout value after which outgoing IIOP connections terminate.
It can be configured by setting the application variable
<strong>iiop_connection_timeout TimeVal (seconds)</strong>, if it is not set it will have the default value
<strong>infinity</strong>. The connection will not be terminated if there are
pending requests.</p>
<p>Note: the iiop_connection_timeout configuration parameter (TimeVal) may only range between 0 and 1000000 seconds.
Otherwise, the default value is used.</p>
</p></div>
<p><a name="iiop_connections-0"><span class="bold_code">iiop_connections() -> Result</span></a><br><a name="iiop_connections-1"><span class="bold_code">iiop_connections(Direction) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Direction = in | out | inout</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = [{Host, Port}] | [{Host, Port, Interface}] | {'EXIT',Reason}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Host = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Port = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Interface = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>The list returned by this operation contain tuples of remote hosts/ports
Orber is currently connected to. If no Direction is not supplied, both
incoming and outgoing connections are included.</p>
<p>If a specific local interface has been defined for the connection,
this will be added to the returned tuple.</p>
</p></div>
<p><a name="iiop_connections_pending-0"><span class="bold_code">iiop_connections_pending() -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Result = [{Host, Port}] | [{Host, Port, Interface}] | {'EXIT',Reason}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Host = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Port = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Interface = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>In some cases a connection attempt (i.e. trying to communicate with
another ORB) may block due to a number of reasons. This operation
allows the user to check if this is the case. The returned list
contain tuples of remote hosts/ports. Normally, the list is empty.</p>
<p>If a specific local interface has been defined for the connection,
this will be added to the returned tuple.</p>
</p></div>
<p><a name="iiop_in_connection_timeout-0"><span class="bold_code">iiop_in_connection_timeout() -> int() (milliseconds)</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the timeout value after which incoming IIOP
connections terminate. It can be configured by setting the application
variable <strong>iiop_in_connection_timeout TimeVal (seconds)</strong>, if it is
not set it will have the default value <strong>infinity</strong>. The connection
will not be terminated if there are pending requests.</p>
<p>Note: the iiop_in_connection_timeout configuration parameter (TimeVal) may
only range between 0 and 1000000 seconds. Otherwise, the default value is
used.</p>
</p></div>
<p><a name="iiop_acl-0"><span class="bold_code">iiop_acl() -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Result = [{Direction, Filter}] | [{Direction, Filter, [Interface]}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Direction = tcp_in | ssl_in | tcp_out | ssl_out</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Filter = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Interface = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Returns the ACL configuration. The <span class="code">Filter</span> uses a extended format of
Classless Inter Domain Routing (CIDR). For example, <span class="code">"123.123.123.10"</span> limits
the connection to that particular host, while <span class="code">"123.123.123.10/17"</span> allows
connections to or from any host equal to the 17 most significant bits. Orber
also allow the user to specify a certain port or port range, for example,
<span class="code">"123.123.123.10/17#4001"</span> and <span class="code">"123.123.123.10/17#4001/5001"</span>
respectively. IPv4 or none compressed IPv6 strings are accepted. <br>
The list of <span class="code">Interfaces</span>, IPv4 or IPv6 strings, are currently only used
for outgoing connections and may only contain <strong>one</strong> address. If set and
access is granted, Orber will use that local interface when connecting to the
other ORB. The module <span class="bold_code"><a href="orber_acl.html">orber_acl</a></span>
provides operations for evaluating the access control for filters and addresses.</p>
</p></div>
<p><a name="activate_audit_trail-0"><span class="bold_code">activate_audit_trail() -> Result</span></a><br><a name="activate_audit_trail-1"><span class="bold_code">activate_audit_trail(Verbosity) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Verbosity = stealth | normal | verbose</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, Reason}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Activates audit/trail for all existing incoming and outgoing IIOP
connections. The <span class="code">Verbosity</span> parameter, <span class="code">stealth</span>,
<span class="code">normal</span> or <span class="code">verbose</span>, determines which of the built in
interceptors is used (<span class="code">orber_iiop_tracer_stealth</span>,
<span class="code">orber_iiop_tracer_silent</span> or <span class="code">orber_iiop_tracer</span> respectively).
If no verbosity level is supplied, then the <span class="code">normal</span> will be used.</p>
<p>In case Orber is configured to use other interceptors, the audit/trail
interceptors will simply be added to that list.</p>
</p></div>
<p><a name="deactivate_audit_trail-0"><span class="bold_code">deactivate_audit_trail() -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error, Reason}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Deactivates audit/trail for all existing incoming and outgoing IIOP
connections. In case Orber is configured to use other interceptors,
those will still be used.</p>
</p></div>
<p><a name="add_listen_interface-2"><span class="bold_code">add_listen_interface(IP, Type) -> Result</span></a><br><a name="add_listen_interface-3"><span class="bold_code">add_listen_interface(IP, Type, Port) -> Result</span></a><br><a name="add_listen_interface-3"><span class="bold_code">add_listen_interface(IP, Type, ConfigurationParameters) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">IP = string</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Type = normal | ssl</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Port = integer() > 0</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ConfigurationParameters = [{Key, Value}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = flags | iiop_in_connection_timeout | iiop_max_fragments | iiop_max_in_requests | interceptors | iiop_port | iiop_ssl_port | ssl_server_options</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Value = as described in the User's Guide</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = {ok, Ref} | {error, Reason} | {'EXCEPTION', #'BAD_PARAM'{}}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Ref = #Ref</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Create a new process that handle requests for creating a new incoming
IIOP connection via the given interface and port. If the latter is
excluded, Orber will use the value of the <span class="code">iiop_port</span> or
<span class="code">iiop_ssl_port</span> configuration parameters.
The <span class="code">Type</span> parameter determines if it is
supposed to be IIOP or IIOP via SSL. If successful, the returned
<span class="code">#Ref</span> shall be passed to <span class="code">orber:remove_listen_interface/1</span>
when the connection shall be terminated.</p>
<p>It is also possible to supply configuration parameters that override
the global configuration. The <strong>iiop_in_connection_timeout</strong>,
<strong>iiop_max_fragments</strong>, <strong>iiop_max_in_requests</strong> and
<strong>interceptors</strong> parameters simply overrides the global
counterparts (See the
<span class="bold_code"><a href="ch_install.html#config">Configuration</a></span> chapter
in the User's Guide).
But for the following parameters there are a few restrictions:</p>
<ul>
<li>
<strong>flags</strong> - currently it is only possible to override the global
setting for the <span class="code">Use Current Interface in IOR</span> and
<span class="code">Exclude CodeSet Component</span> flags.</li>
<li>
<strong>iiop_port</strong> - requires that <span class="code">Use Current Interface in IOR</span>
is activated and the supplied <span class="code">Type</span> is <span class="code">normal</span>. If so,
exported IOR:s will contain the IIOP port defined by this configuration
parameter. Otherwise, the global setting will be used.</li>
<li>
<strong>iiop_ssl_port</strong> - almost equivalent to <span class="code">iiop_port</span>.
The difference is that <span class="code">Type</span> shall be <span class="code">ssl</span> and that
exported IOR:s will contain the IIOP via SSL port defined by this configuration
parameter.</li>
</ul>
<p>If it is not possible to add a listener based on the supplied interface
and port, the error message is one of the ones described in <span class="code">inet</span>
and/or <span class="code">ssl</span> documentation.</p>
</p></div>
<p><a name="remove_listen_interface-1"><span class="bold_code">remove_listen_interface(Ref) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Ref = #Ref</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Terminates the listen process, associated with the supplied <span class="code">#Ref</span>,
for incoming a connection. The Ref parameter is the return value from
the <span class="code">orber:add_listen_interface/2/3</span> operation. When terminating
the connection, all associated requests will not deliver a reply to
the clients.</p>
</p></div>
<p><a name="close_connection-1"><span class="bold_code">close_connection(Connection) -> Result</span></a><br><a name="close_connection-2"><span class="bold_code">close_connection(Connection, Interface) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Connection = Object | [{Host, Port}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Object = #objref (external)</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Host = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Port = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Interface = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {'EXCEPTION', #'BAD_PARAM'{}}</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Will try to close all outgoing connections to the host/port combinations
found in the supplied object reference or the given list of hosts/ports.
If a <span class="code">#'IOP_ServiceContext'{}</span> containing a local interface has been
used when communicating with the remote object
(see also <span class="bold_code"><a href="Module_Interface.html">Module_Interface</a></span>),
that interface shall be passed as the second argument. Otherwise, connections
via the default local interface, will be terminated.</p>
<p></p>
<div class="note">
<div class="label">Note</div>
<div class="content"><p>
<p>Since several clients maybe communicates via the same connection,
they will be affected when invoking this operation. Other clients may
re-create the connection by invoking an operation on the target object.</p>
</p></div>
</div>
</p></div>
<p><a name="secure-0"><span class="bold_code">secure() -> no | ssl</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the security mode Orber is running in, which is either no if it is an
insecure domain or the type of security mechanism used. For the moment the only security
mechanism is ssl. This is configured by setting the application variable
<strong>secure</strong>.</p>
</p></div>
<p><a name="ssl_server_options-0"><span class="bold_code">ssl_server_options() -> list()</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the list of SSL options set for the Orber domain as server.
This is configured by setting the application variable
<strong>ssl_server_options</strong>.</p>
</p></div>
<p><a name="ssl_client_options-0"><span class="bold_code">ssl_client_options() -> list()</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the list of SSL options used in outgoing calls in the current process.
The default value is configured by setting the application variable
<strong>ssl_client_options</strong>.</p>
</p></div>
<p><a name="set_ssl_client_options-1"><span class="bold_code">set_ssl_client_options(Options) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Options = list()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function takes a list of SSL options as parameter and sets
it for the current process.</p>
</p></div>
<p><a name="objectkeys_gc_time-0"><span class="bold_code">objectkeys_gc_time() -> int() (seconds)</span></a><br></p>
<div class="REFBODY"><p>
<p>This function returns the timeout value after which after which terminated object keys,
related to servers started with the configuration parameter <span class="code">{persistent, true}</span>,
will be removed.
It can be configured by setting the application variable <strong>objectkeys_gc_time TimeVal (seconds)</strong>,
if it is not set it will have the default value <strong>infinity</strong>. </p>
<p>Objects terminating with reason <strong>normal</strong> or <strong>shutdown</strong> are removed automatically.</p>
<p>Note: the objectkeys_gc_time configuration parameter (TimeVal) may only range between 0 and 1000000 seconds.
Otherwise, the default value is used.</p>
</p></div>
<p><a name="orber_nodes-0"><span class="bold_code">orber_nodes() -> RetVal</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">RetVal = [node()]</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function returns the list of node names that this orber
domain consists of. </p>
</p></div>
<p><a name="install-1"><span class="bold_code">install(NodeList) -> ok</span></a><br><a name="install-2"><span class="bold_code">install(NodeList, Options) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">NodeList = [node()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Options = [Option]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Option = {install_timeout, Timeout} | {ifr_storage_type, TableType} | {nameservice_storage_type, TableType} | {initialreferences_storage_type, TableType} | {load_order, Priority}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = infinity | integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TableType = disc_copies | ram_copies</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Priority = integer()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function installs all the necessary mnesia tables and
load default data in some of them. If one or more Orber tables
already exists the installation fails. The function
<strong>uninstall</strong> may be used, if it is safe, i.e., no other
application is running Orber.</p>
<p>Preconditions:</p>
<ul>
<li>a mnesia schema must exist before the installation</li>
<li>mnesia is running on the other nodes if the new installation
shall be a multi node domain</li>
</ul>
<p>Mnesia will be started by the function if it is not already running on
the installation node and if it was started it will be stopped
afterwards.</p>
<p>The options that can be sent to the installation program is:</p>
<ul>
<li>
<span class="code">{install_timeout, Timeout}</span> - this timeout is how long we
will wait for the tables to be created. The Timeout value can be
<strong>infinity</strong> or an integer number in milliseconds.
Default is infinity.</li>
<li>
<span class="code">{ifr_storage_type, TableType}</span> - this option sets the
type of tables used for the interface repository.
The TableType can be disc_copies or ram_copies. Default is
disc_copies.</li>
<li>
<span class="code">{initialreferences_storage_type, TableType}</span> - this option
sets the type of table used for storing initial references.
The TableType can be disc_copies or ram_copies. Default is
ram_copies.</li>
<li>
<span class="code">{nameservice_storage_type, TableType}</span> - the default
behavior of Orber is to install the NameService as ram_copies.
This option makes it possible to change this to disc_copies. But
the user should be aware of that if a node is restarted, all
local object references stored in the NameService is not valid.
Hence, you cannot switch to disc_copies and expect exactly the same
behavior as before.</li>
<li>
<span class="code">{load_order, Priority}</span> - per default the priority is set to 0.
Using this option it will change the priority of in which order
Mnesia will load Orber internal tables. For more information,
consult the Mnesia documentation.</li>
</ul>
</p></div>
<p><a name="uninstall-0"><span class="bold_code">uninstall() -> ok</span></a><br></p>
<div class="REFBODY"><p>
<p>This function stops the Orber application, terminates all server
objects and removes all Orber related mnesia tables.</p>
<p>Note: Since other applications may be running on the same node
using mnesia <strong>uninstall</strong> will not stop the mnesia application.</p>
</p></div>
<p><a name="add_node-2"><span class="bold_code">add_node(Node, Options) -> RetVal</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Node = node()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Options = IFRStorageType | [KeyValue] </span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">IFRStorageType = StorageType</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">StorageType = disc_copies | ram_copies</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">KeyValue = {ifr_storage_type, StorageType} | {initialreferences_storage_type, StorageType} | {nameservice_storage_type, StorageType} | {type, Type} </span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Type = temporary | permanent</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">RetVal = ok | exit()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function add given node to a existing Orber node group and starts
Orber on the new node. <span class="code">orber:add_node</span> is called from a member in the Orber
node group.</p>
<p>Preconditions for new node:</p>
<ul>
<li>Erlang started on the new node using the option <span class="code">-mnesia extra_db_nodes</span>, e.g.,
<span class="code">erl -sname new_node_name -mnesia extra_db_nodes ConnectToNodes_List</span>
</li>
<li>The new node's <span class="code">domain</span> name is the same for the nodes we want to connect to.</li>
<li>Mnesia is running on the new node (no new schema created).</li>
<li>If the new node will use <span class="code">disc_copies</span> the schema type must be changed using:
<span class="code">mnesia:change_table_copy_type(schema, node(), disc_copies).</span>
</li>
</ul>
<p>Orber will be started by the function on the new node.</p>
<p>Fails if:</p>
<ul>
<li>Orber already installed on given node.</li>
<li>Mnesia not started as described above on the new node.</li>
<li>Impossible to copy data in Mnesia tables to the new node.</li>
<li>Not able to start Orber on the new node, due to, for example, the
<span class="code">iiop_port</span> is already in use.</li>
</ul>
<p>The function do not remove already copied tables after a failure.
Use <span class="code">orber:remove_node</span> to remove these tables.</p>
</p></div>
<p><a name="remove_node-1"><span class="bold_code">remove_node(Node) -> RetVal</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Node = node()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">RetVal = ok | exit()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function removes given node from a Orber node group. The Mnesia
application is not stopped.</p>
</p></div>
<p><a name="configure-2"><span class="bold_code">configure(Key, Value) -> ok | {'EXIT', Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Key = orbDefaultInitRef | orbInitRef | giop_version | iiop_timeout | iiop_connection_timeout | iiop_setup_connection_timeout | iiop_in_connection_timeout | objectkeys_gc_time | orber_debug_level</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Value = allowed value associated with the given key</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function allows the user to configure Orber in, for example,
an Erlang shell. It is possible to invoke <span class="code">configure</span> at any time
the keys specified above.</p>
<p>Any other key must be set before installing and starting Orber.</p>
<p>Trying to change the configuration in any other way is <strong>NOT</strong>
allowed since it may affect the behavior of Orber.</p>
<p>For more information regarding allowed values, see
<span class="bold_code"><a href="ch_install.html#config">configuration settings</a></span>
in the User's Guide.</p>
<p></p>
<div class="note">
<div class="label">Note</div>
<div class="content"><p>
<p>Configuring the IIOP timeout values will not affect already
existing connections. If you want a guaranteed uniform behavior, you
must set these parameters from the start.</p>
</p></div>
</div>
</p></div>
</div>
<div class="footer">
<hr>
<p>Copyright © 1997-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
1115
