trusty (3) Eliom_client.client.3o.gz

NAME

       Eliom_client - Call server side services and change the current page.

Module

       Module   Eliom_client

Documentation

       Module Eliom_client
        : sig end

       Call server side services and change the current page.

       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.appl_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_caml_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_parameter.caml) 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_caml_service raises an exception  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_caml_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  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:

       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