Ocamlnet 4 Reference Manual : Rpc_server

`sig
exception Connection_lost
type t
type session
type connection_id
type connector =
Localhost of int
| Portmapped
| Internet of (Unix.inet_addr * int)
| Unix of string
| W32_pipe of string
| Descriptor of Unix.file_descr
| Dynamic_descriptor of (unit -> Unix.file_descr)
type binding_sync = {
sync_name : string;
sync_proc : Rpc_server.t -> Netxdr.xdr_value -> Netxdr.xdr_value;
}
type binding_async = {
async_name : string;
async_invoke :
Rpc_server.t -> Rpc_server.session -> Netxdr.xdr_value -> unit;
}
type binding =
Sync of Rpc_server.binding_sync
| Async of Rpc_server.binding_async
val connector_of_sockaddr : Unix.sockaddr -> Rpc_server.connector
val connector_of_socksymbol :
Netsockaddr.socksymbol -> Rpc_server.connector
val create :
?program_number:Netnumber.uint4 ->
?version_number:Netnumber.uint4 ->
Unixqueue.event_system ->
Rpc_server.connector ->
Rpc.protocol ->
Rpc.mode ->
Rpc_program.t -> Rpc_server.binding list -> int -> Rpc_server.t
class type socket_config =
object
method listen_options : Uq_engines.listen_options
method multiplexing :
dbg_name:string Pervasives.ref ->
close_inactive_descr:bool ->
Rpc.protocol ->
Unix.file_descr ->
Unixqueue.event_system ->
Rpc_transport.rpc_multiplex_controller Uq_engines.engine
end
val default_socket_config : Rpc_server.socket_config
class default_socket_config : socket_config
val tls_socket_config :
(module Netsys_crypto_types.TLS_CONFIG) -> Rpc_server.socket_config
class tls_socket_config :
(module Netsys_crypto_types.TLS_CONFIG) -> socket_config
type internal_pipe = Netxdr.xdr_value Netsys_polypipe.polypipe
type internal_socket = Netxdr.xdr_value Netsys_polysocket.polyserver
type mode2 =
[ `Dummy of Rpc.protocol
| `Internal_endpoint of
Rpc_server.internal_pipe * Rpc_server.internal_pipe
| `Internal_socket of Rpc_server.internal_socket
| `Multiplexer_endpoint of Rpc_transport.rpc_multiplex_controller
| `Socket of
Rpc.protocol * Rpc_server.connector * Rpc_server.socket_config
| `Socket_endpoint of Rpc.protocol * Unix.file_descr ]
val create2 : Rpc_server.mode2 -> Unixqueue.event_system -> Rpc_server.t
val bind :
?program_number:Netnumber.uint4 ->
?version_number:Netnumber.uint4 ->
?pm_continue:bool ->
Rpc_program.t -> Rpc_server.binding list -> Rpc_server.t -> unit
val unbind :
?program_number:Netnumber.uint4 ->
?version_number:Netnumber.uint4 -> Rpc_program.t -> Rpc_server.t -> unit
val bound_programs : Rpc_server.t -> Rpc_program.t list
val get_event_system : Rpc_server.session -> Unixqueue.event_system
val get_connection_id : Rpc_server.session -> Rpc_server.connection_id
val get_xid : Rpc_server.session -> Netnumber.uint4
val get_socket_name : Rpc_server.session -> Unix.sockaddr
val get_peer_name : Rpc_server.session -> Unix.sockaddr
val get_conn_socket_name : Rpc_server.connection_id -> Unix.sockaddr
val get_conn_peer_name : Rpc_server.connection_id -> Unix.sockaddr
val get_server : Rpc_server.session -> Rpc_server.t
val get_main_socket_name : Rpc_server.t -> Unix.sockaddr
val get_protocol : Rpc_server.t -> Rpc.protocol
val get_srv_event_system : Rpc_server.t -> Unixqueue.unix_event_system
val get_last_proc_info : Rpc_server.t -> string
val is_dummy : Rpc_server.t -> bool
val get_tls_session_props :
Rpc_server.session -> Nettls_support.tls_session_props option
val get_gssapi_props :
Rpc_server.session -> Netsys_gssapi.server_props option
type rule =
[ `Accept
| `Accept_limit_length of int * Rpc_server.rule
| `Deny
| `Drop
| `Reject
| `Reject_with of Rpc.server_error ]
val set_session_filter :
Rpc_server.t -> (Rpc_transport.sockaddr -> Rpc_server.rule) -> unit
val set_session_filter_2 :
Rpc_server.t ->
(Rpc_transport.sockaddr -> Rpc_server.connection_id -> Rpc_server.rule) ->
unit
val set_mstring_factories :
Rpc_server.t -> Netxdr_mstring.named_mstring_factories -> unit
val reply : Rpc_server.session -> Netxdr.xdr_value -> unit
val reply_error : Rpc_server.session -> Rpc.server_error -> unit
val set_exception_handler : Rpc_server.t -> (exn -> string -> unit) -> unit
val set_onclose_action :
Rpc_server.t -> (Rpc_server.connection_id -> unit) -> unit
val set_timeout : Rpc_server.t -> float -> unit
val stop_server : ?graceful:bool -> Rpc_server.t -> unit
val stop_connection : Rpc_server.t -> Rpc_server.connection_id -> unit
type auth_result =
Auth_positive of
(string * string * string * Netxdr.encoder option *
Netxdr.decoder option * Netsys_gssapi.server_props option)
| Auth_negative of Rpc.server_error
| Auth_reply of (Netxdr_mstring.mstring list * string * string)
| Auth_drop
exception Late_drop
type auth_peeker =
[ `None
| `Peek_descriptor of Unix.file_descr -> string option
| `Peek_multiplexer of
Rpc_transport.rpc_multiplex_controller -> string option ]
class type auth_details =
object
method client_addr : Unix.sockaddr option
method credential : string * string
method frame_len : int
method message : Rpc_packer.packed_value
method procedure : Netnumber.uint4
method program : Netnumber.uint4
method server_addr : Unix.sockaddr option
method transport_user : string option
method verifier : string * string
method version : Netnumber.uint4
method xid : Netnumber.uint4
end
class type auth_method =
object
method authenticate :
Rpc_server.t ->
Rpc_server.connection_id ->
Rpc_server.auth_details -> (Rpc_server.auth_result -> unit) -> unit
method flavors : string list
method invalidate : unit -> unit
method invalidate_connection : Rpc_server.connection_id -> unit
method name : string
method peek : Rpc_server.auth_peeker
end
val set_auth_methods : Rpc_server.t -> Rpc_server.auth_method list -> unit
val auth_none : Rpc_server.auth_method
val auth_too_weak : Rpc_server.auth_method
val auth_transport : Rpc_server.auth_method
val get_user : Rpc_server.session -> string
val get_auth_method : Rpc_server.session -> Rpc_server.auth_method
val xdr_ctx : Rpc_server.t -> Netxdr.ctx
val verbose : bool -> unit
val detach : Rpc_server.t -> unit
val set_debug_name : Rpc_server.t -> string -> unit
val get_debug_name : Rpc_server.t -> string
module Debug :
sig
val enable : bool Pervasives.ref
val enable_ctrace : bool Pervasives.ref
val enable_ptrace : bool Pervasives.ref
val ptrace_verbosity : Rpc_util.verbosity Pervasives.ref
val disable_for_server : Rpc_server.t -> unit
end
end`