<html><head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
<link title="Equeue" rel="Chapter" href="Equeue.html">
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
<link title="Unixqueue_mt" rel="Chapter" href="Unixqueue_mt.html">
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
<link title="Uq_ssl" rel="Chapter" href="Uq_ssl.html">
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
<link title="Http_client" rel="Chapter" href="Http_client.html">
<link title="Telnet_client" rel="Chapter" href="Telnet_client.html">
<link title="Ftp_data_endpoint" rel="Chapter" href="Ftp_data_endpoint.html">
<link title="Ftp_client" rel="Chapter" href="Ftp_client.html">
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
<link title="Netshm" rel="Chapter" href="Netshm.html">
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
<link title="Netstream" rel="Chapter" href="Netstream.html">
<link title="Mimestring" rel="Chapter" href="Mimestring.html">
<link title="Netmime" rel="Chapter" href="Netmime.html">
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
<link title="Neturl" rel="Chapter" href="Neturl.html">
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
<link title="Netdate" rel="Chapter" href="Netdate.html">
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
<link title="Netulex" rel="Chapter" href="Netulex.html">
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
<link title="Netstring_mt" rel="Chapter" href="Netstring_mt.html">
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
<link title="Netaux" rel="Chapter" href="Netaux.html">
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
<link title="Netsys" rel="Chapter" href="Netsys.html">
<link title="Netpop" rel="Chapter" href="Netpop.html">
<link title="Rpc_auth_dh" rel="Chapter" href="Rpc_auth_dh.html">
<link title="Rpc_key_service" rel="Chapter" href="Rpc_key_service.html">
<link title="Rpc_time" rel="Chapter" href="Rpc_time.html">
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
<link title="Rtypes" rel="Chapter" href="Rtypes.html">
<link title="Xdr" rel="Chapter" href="Xdr.html">
<link title="Rpc" rel="Chapter" href="Rpc.html">
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
<link title="Rpc_ssl" rel="Chapter" href="Rpc_ssl.html">
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
<link title="Shell" rel="Chapter" href="Shell.html">
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
<link title="Shell_mt" rel="Chapter" href="Shell_mt.html">
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html"><title>Ocamlnet 2 Reference Manual : Rpc_server</title>
</head>
<body>
<code class="code"><span class="keyword">sig</span><br>
<span class="keyword">exception</span> <span class="constructor">Connection_lost</span><br>
<span class="keyword">type</span> t<br>
<span class="keyword">type</span> session<br>
<span class="keyword">type</span> connection_id<br>
<span class="keyword">type</span> connector =<br>
<span class="constructor">Localhost</span> <span class="keyword">of</span> int<br>
<span class="keywordsign">|</span> <span class="constructor">Portmapped</span><br>
<span class="keywordsign">|</span> <span class="constructor">Internet</span> <span class="keyword">of</span> (<span class="constructor">Unix</span>.inet_addr * int)<br>
<span class="keywordsign">|</span> <span class="constructor">Unix</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="constructor">Descriptor</span> <span class="keyword">of</span> <span class="constructor">Unix</span>.file_descr<br>
<span class="keywordsign">|</span> <span class="constructor">Dynamic_descriptor</span> <span class="keyword">of</span> (unit <span class="keywordsign">-></span> <span class="constructor">Unix</span>.file_descr)<br>
<span class="keyword">type</span> binding_sync = {<br>
sync_name : string;<br>
sync_proc : <span class="constructor">Xdr</span>.xdr_value <span class="keywordsign">-></span> <span class="constructor">Xdr</span>.xdr_value;<br>
}<br>
<span class="keyword">type</span> binding_async = {<br>
async_name : string;<br>
async_invoke : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Xdr</span>.xdr_value <span class="keywordsign">-></span> unit;<br>
}<br>
<span class="keyword">type</span> binding =<br>
<span class="constructor">Sync</span> <span class="keyword">of</span> <span class="constructor">Rpc_server</span>.binding_sync<br>
<span class="keywordsign">|</span> <span class="constructor">Async</span> <span class="keyword">of</span> <span class="constructor">Rpc_server</span>.binding_async<br>
<span class="keyword">val</span> create :<br>
?program_number:<span class="constructor">Rtypes</span>.uint4 <span class="keywordsign">-></span><br>
?version_number:<span class="constructor">Rtypes</span>.uint4 <span class="keywordsign">-></span><br>
<span class="constructor">Unixqueue</span>.event_system <span class="keywordsign">-></span><br>
<span class="constructor">Rpc_server</span>.connector <span class="keywordsign">-></span><br>
<span class="constructor">Rpc</span>.protocol <span class="keywordsign">-></span><br>
<span class="constructor">Rpc</span>.mode <span class="keywordsign">-></span><br>
<span class="constructor">Rpc_program</span>.t <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.binding list <span class="keywordsign">-></span> int <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.t<br>
<span class="keyword">class</span> <span class="keyword">type</span> socket_config =<br>
<span class="keyword">object</span><br>
<span class="keyword">method</span> listen_options : <span class="constructor">Uq_engines</span>.listen_options<br>
<span class="keyword">method</span> multiplexing :<br>
close_inactive_descr:bool <span class="keywordsign">-></span><br>
<span class="constructor">Rpc</span>.protocol <span class="keywordsign">-></span><br>
<span class="constructor">Unix</span>.file_descr <span class="keywordsign">-></span><br>
<span class="constructor">Unixqueue</span>.event_system <span class="keywordsign">-></span><br>
<span class="constructor">Rpc_transport</span>.rpc_multiplex_controller <span class="constructor">Uq_engines</span>.engine<br>
<span class="keyword">end</span><br>
<span class="keyword">val</span> default_socket_config : <span class="constructor">Rpc_server</span>.socket_config<br>
<span class="keyword">class</span> default_socket_config : socket_config<br>
<span class="keyword">type</span> mode2 =<br>
[ <span class="keywordsign">`</span><span class="constructor">Multiplexer_endpoint</span> <span class="keyword">of</span> <span class="constructor">Rpc_transport</span>.rpc_multiplex_controller<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Socket</span> <span class="keyword">of</span><br>
<span class="constructor">Rpc</span>.protocol * <span class="constructor">Rpc_server</span>.connector * <span class="constructor">Rpc_server</span>.socket_config<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Socket_endpoint</span> <span class="keyword">of</span> <span class="constructor">Rpc</span>.protocol * <span class="constructor">Unix</span>.file_descr ]<br>
<span class="keyword">val</span> create2 : <span class="constructor">Rpc_server</span>.mode2 <span class="keywordsign">-></span> <span class="constructor">Unixqueue</span>.event_system <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.t<br>
<span class="keyword">val</span> bind :<br>
?program_number:<span class="constructor">Rtypes</span>.uint4 <span class="keywordsign">-></span><br>
?version_number:<span class="constructor">Rtypes</span>.uint4 <span class="keywordsign">-></span><br>
<span class="constructor">Rpc_program</span>.t <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.binding list <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> unbind :<br>
?program_number:<span class="constructor">Rtypes</span>.uint4 <span class="keywordsign">-></span><br>
?version_number:<span class="constructor">Rtypes</span>.uint4 <span class="keywordsign">-></span> <span class="constructor">Rpc_program</span>.t <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> bound_programs : <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> <span class="constructor">Rpc_program</span>.t list<br>
<span class="keyword">val</span> get_event_system : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Unixqueue</span>.event_system<br>
<span class="keyword">val</span> get_connection_id : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.connection_id<br>
<span class="keyword">val</span> get_xid : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Rtypes</span>.uint4<br>
<span class="keyword">val</span> get_socket_name : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Unix</span>.sockaddr<br>
<span class="keyword">val</span> get_peer_name : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Unix</span>.sockaddr<br>
<span class="keyword">val</span> get_conn_socket_name : <span class="constructor">Rpc_server</span>.connection_id <span class="keywordsign">-></span> <span class="constructor">Unix</span>.sockaddr<br>
<span class="keyword">val</span> get_conn_peer_name : <span class="constructor">Rpc_server</span>.connection_id <span class="keywordsign">-></span> <span class="constructor">Unix</span>.sockaddr<br>
<span class="keyword">val</span> get_server : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.t<br>
<span class="keyword">val</span> get_main_socket_name : <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> <span class="constructor">Unix</span>.sockaddr<br>
<span class="keyword">val</span> get_protocol : <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> <span class="constructor">Rpc</span>.protocol<br>
<span class="keyword">val</span> get_srv_event_system : <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> <span class="constructor">Unixqueue</span>.unix_event_system<br>
<span class="keyword">type</span> rule =<br>
[ <span class="keywordsign">`</span><span class="constructor">Accept</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Accept_limit_length</span> <span class="keyword">of</span> int * <span class="constructor">Rpc_server</span>.rule<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Deny</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Drop</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Reject</span> ]<br>
<span class="keyword">val</span> set_session_filter :<br>
<span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> (<span class="constructor">Unix</span>.sockaddr <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.rule) <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> set_session_filter_2 :<br>
<span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span><br>
(<span class="constructor">Unix</span>.sockaddr <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.connection_id <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.rule) <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> reply : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Xdr</span>.xdr_value <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> reply_error : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Rpc</span>.server_error <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> set_exception_handler : <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> (exn <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> set_onclose_action :<br>
<span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> (<span class="constructor">Rpc_server</span>.connection_id <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> set_timeout : <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> stop_server : ?graceful:bool <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> stop_connection : <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.connection_id <span class="keywordsign">-></span> unit<br>
<span class="keyword">type</span> auth_result =<br>
<span class="constructor">Auth_positive</span> <span class="keyword">of</span> (string * string * string)<br>
<span class="keywordsign">|</span> <span class="constructor">Auth_negative</span> <span class="keyword">of</span> <span class="constructor">Rpc</span>.server_error<br>
<span class="keyword">type</span> auth_peeker =<br>
[ <span class="keywordsign">`</span><span class="constructor">None</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Peek_descriptor</span> <span class="keyword">of</span> <span class="constructor">Unix</span>.file_descr <span class="keywordsign">-></span> string option<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Peek_multiplexer</span> <span class="keyword">of</span><br>
<span class="constructor">Rpc_transport</span>.rpc_multiplex_controller <span class="keywordsign">-></span> string option ]<br>
<span class="keyword">class</span> <span class="keyword">type</span> auth_method =<br>
<span class="keyword">object</span><br>
<span class="keyword">method</span> authenticate :<br>
<span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span><br>
<span class="constructor">Rpc_server</span>.connection_id <span class="keywordsign">-></span><br>
<span class="constructor">Unix</span>.sockaddr option <span class="keywordsign">-></span><br>
<span class="constructor">Unix</span>.sockaddr option <span class="keywordsign">-></span><br>
string <span class="keywordsign">-></span><br>
string <span class="keywordsign">-></span><br>
string <span class="keywordsign">-></span> string <span class="keywordsign">-></span> (<span class="constructor">Rpc_server</span>.auth_result <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> unit<br>
<span class="keyword">method</span> flavors : string list<br>
<span class="keyword">method</span> name : string<br>
<span class="keyword">method</span> peek : <span class="constructor">Rpc_server</span>.auth_peeker<br>
<span class="keyword">end</span><br>
<span class="keyword">val</span> set_auth_methods : <span class="constructor">Rpc_server</span>.t <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.auth_method list <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> auth_none : <span class="constructor">Rpc_server</span>.auth_method<br>
<span class="keyword">val</span> auth_too_weak : <span class="constructor">Rpc_server</span>.auth_method<br>
<span class="keyword">val</span> auth_transport : <span class="constructor">Rpc_server</span>.auth_method<br>
<span class="keyword">val</span> get_user : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> string<br>
<span class="keyword">val</span> get_auth_method : <span class="constructor">Rpc_server</span>.session <span class="keywordsign">-></span> <span class="constructor">Rpc_server</span>.auth_method<br>
<span class="keyword">val</span> verbose : bool <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> debug_internals_log : (string <span class="keywordsign">-></span> unit) option <span class="constructor">Pervasives</span>.ref<br>
<span class="keyword">val</span> debug_service_log : (string <span class="keywordsign">-></span> unit) option <span class="constructor">Pervasives</span>.ref<br>
<span class="keyword">end</span></code></body></html>
