This is client API (go to server)

Module Eliom_client

module Eliom_client : sig..end

Call server side services and change the current page.


val init_client_app : 
  ?ssl:bool ->
  hostname:string ->
  ?port:int -> full_path:Eliom_lib.Url.path -> unit -> unit

Call this function if you want to be able to run your client side app before doing the first request, that is, when the client side app is not sent by the server. This may be the case for example if you are developing a mobile app. The parameters correspond to the base URL of the server side of your application.

val change_page : 
  ?absolute:bool ->
  ?absolute_path:bool ->
  ?https:bool ->
  service:('a, 'b, [< Eliom_service.service_kind ],
   [< Eliom_service.suff ], 'd, 'e,
   [< Eliom_service.registrable ],
   [< Eliom_registration.non_ocaml_service ])
   Eliom_service.service ->
  ?hostname:string ->
  ?port:int ->
  ?fragment:string ->
  ?keep_nl_params:[ `All | `None | `Persistent ] ->
  ?nl_params:Eliom_parameter.nl_params_set ->
  ?keep_get_na_params:bool -> 'a -> 'b -> unit Lwt.t

Call a server side service and change the current page. If the service belongs to the same application, the client side program is not stopped, and only the content (not the container) is reloaded.

val call_ocaml_service : 
  ?absolute:bool ->
  ?absolute_path:bool ->
  ?https:bool ->
  service:('a, 'b, [< Eliom_service.service_kind ],
   [< Eliom_service.suff ], 'd, 'e,
   [< Eliom_service.registrable ],
   'return Eliom_service.ocaml_service)
   Eliom_service.service ->
  ?hostname:string ->
  ?port:int ->
  ?fragment:string ->
  ?keep_nl_params:[ `All | `None | `Persistent ] ->
  ?nl_params:Eliom_parameter.nl_params_set ->
  ?keep_get_na_params:bool -> 'a -> 'b -> 'return Lwt.t

Call a server side service that return an OCaml value.

If the service raises an exception, the call to the call_ocaml_service raises an exception Exception_on_server whose argument describes the server-side exception. (NB that we cannot send the original exception as-it, because OCaml permits the marshalling of exceptions ...)

val exit_to : 
  ?absolute:bool ->
  ?absolute_path:bool ->
  ?https:bool ->
  service:('a, 'b, [< Eliom_service.service_kind ],
   [< Eliom_service.suff ], 'd, 'e,
   [< Eliom_service.registrable ],
   [< Eliom_registration.non_ocaml_service ])
   Eliom_service.service ->
  ?hostname:string ->
  ?port:int ->
  ?fragment:string ->
  ?keep_nl_params:[ `All | `None | `Persistent ] ->
  ?nl_params:Eliom_parameter.nl_params_set ->
  ?keep_get_na_params:bool -> 'a -> 'b -> unit

Stop current program and load a new page. Note that for string arguments, sole line feed or sole carriage return characters are substituted by the string "\r\n".

val window_open : 
  window_name:Js.js_string Js.t ->
  ?window_features:Js.js_string Js.t ->
  ?absolute:bool ->
  ?absolute_path:bool ->
  ?https:bool ->
  service:('a, unit, [< Eliom_service.get_service_kind ],
   [< Eliom_service.suff ], 'b, unit,
   [< Eliom_service.registrable ], 'c)
   Eliom_service.service ->
  ?hostname:string ->
  ?port:int ->
  ?fragment:string ->
  ?keep_nl_params:[ `All | `None | `Persistent ] ->
  ?nl_params:Eliom_parameter.nl_params_set ->
  ?keep_get_na_params:bool -> 'a -> Dom_html.window Js.t

Loads an Eliom service in a window (cf. Javascript's window.open).

val change_url : 
  ?absolute:bool ->
  ?absolute_path:bool ->
  ?https:bool ->
  service:('get, unit, [< Eliom_service.get_service_kind ],
   [< Eliom_service.suff ], 'gn, unit,
   [< Eliom_service.registrable ], 'return)
   Eliom_service.service ->
  ?hostname:string ->
  ?port:int ->
  ?fragment:string ->
  ?keep_nl_params:[ `All | `None | `Persistent ] ->
  ?nl_params:Eliom_parameter.nl_params_set -> 'get -> unit

Changes the URL, without doing a request. It takes a GET (co-)service as parameter and its parameters.

val call_service : 
  ?absolute:bool ->
  ?absolute_path:bool ->
  ?https:bool ->
  service:('a, 'b, [< Eliom_service.service_kind ],
   [< Eliom_service.suff ], 'd, 'e,
   [< Eliom_service.registrable ], 'return)
   Eliom_service.service ->
  ?hostname:string ->
  ?port:int ->
  ?fragment:string ->
  ?keep_nl_params:[ `All | `None | `Persistent ] ->
  ?nl_params:Eliom_parameter.nl_params_set ->
  ?keep_get_na_params:bool -> 'a -> 'b -> string Lwt.t

(low level) Call a server side service and return the content of the resulting HTTP frame as a string.

val onload : (unit -> unit) -> unit

Registers some code to be executed after loading the client application, or after changing the page the next time.

It complements as a toplevel expression in the client module with the side effect from client values while creating the response of a service: While the latter are executed each time the service has been called; the former is executed only once; but each at a time where the document is in place:

{shared{ open Eliom_lib }}
    {client{
      let () = alert "Once only during initialization of the client, i.e. before the document is available."
      let () =
        Eliom_client.onload
          (fun () -> alert "Once only when the document is put in place.")
    }}
    {server{
      let _ = My_app.register_service ~path ~get_params
        (fun () () ->
           ignore {unit{
             alert "Each time this service is called and the sent document is put in place."
           }};
           Lwt.return html
    }}
val onunload : (unit -> unit) -> unit

Register a function to be called before changing the page the next time.

val wait_load_end : unit -> unit Lwt.t

Wait for the initialization phase to terminate