package ocamldap
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=be85eccfa45de6066238da85c6ad2a409d69df245b6cd2b740ec2bf3400b587c
md5=6137a123978ac5b0dd301af26122e437
doc/ldap/Ldap_funserver/index.html
Module Ldap_funserver
A functional ldap server construction kit
type backendInfo = {bi_op_bind : (connection_id -> Ldap_types.ldap_message -> Ldap_types.ldap_message) option;bi_op_unbind : (connection_id -> Ldap_types.ldap_message -> unit) option;bi_op_search : (connection_id -> Ldap_types.ldap_message -> unit -> Ldap_types.ldap_message) option;bi_op_compare : (connection_id -> Ldap_types.ldap_message -> Ldap_types.ldap_message) option;bi_op_modify : (connection_id -> Ldap_types.ldap_message -> Ldap_types.ldap_message) option;bi_op_modrdn : (connection_id -> Ldap_types.ldap_message -> Ldap_types.ldap_message) option;bi_op_add : (connection_id -> Ldap_types.ldap_message -> Ldap_types.ldap_message) option;bi_op_delete : (connection_id -> Ldap_types.ldap_message -> Ldap_types.ldap_message) option;bi_op_abandon : (connection_id -> Ldap_types.ldap_message -> unit) option;bi_op_extended : (connection_id -> Ldap_types.ldap_message -> Ldap_types.ldap_message) option;bi_init : (unit -> unit) option;bi_close : (unit -> unit) option;
}This structure is the guts of the ldap server. For each operation that you implement put the function (or closure) of the correct type in this structure. Any functions you set as None will return `UNWILLING_TO_PERFORM, with the error string set to "not implemented". bi_init will be called (if it is provided) before the server is brought up, and bi_close (if it is provided) will be called before the server is brought down. This interface is based loosely on the back-end api in OpenLDAP.
This abstract type contains the server context. It has the listening, socket, all the connected client sockets, and some internal data structures.
val init :
?log:(log_level -> string -> unit) ->
?port:int ->
backendInfo ->
server_infoInitialize the server, create the listening socket and return the server context, which you will pass to serv to process connections. log is a string -> log_level -> unit function to which log messages will be sent.
val shutdown : server_info -> unitShutdown the server
val run : server_info -> unitUsing the supplied server context, begin processing ldap operations. This function should never terminate unless there is an exceptional condition, in which case the exception will be raised. In many cases it is safe to restart the server process when an exception happens.