File: lwt_jsonp.mli

package info (click to toggle)
js-of-ocaml 4.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,372 kB
  • sloc: ml: 70,468; javascript: 8,238; ansic: 319; makefile: 217; lisp: 23; sh: 6; perl: 4
file content (31 lines) | stat: -rw-r--r-- 1,549 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
(* Js_of_ocaml library
 * http://www.ocsigen.org/js_of_ocaml/
 * Copyright (C) 2014 Hugo Heuzard
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, with linking exception;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *)

(** This module provides helpers to perform JSONP calls *)

val call : ?timeout:float -> ?param:string -> ?prefix:string -> string -> 'b Lwt.t
(** [call ~timeout ~param url] do a jsonp call using [url].
  It uses the named query parameter [param] (default "callback") to pass the name of the callback.
  It uses [prefix] to generate random string for callback name.
  If a timeout is given and there are no answer before [timeout] seconds, the lwt thread will be cancelled.
*)

val call_custom_url : ?timeout:float -> ?prefix:string -> (string -> string) -> 'b Lwt.t
(** [call_custom_url ~timeout make_url].
    Same as [call] but let you build your own url given a callback name *)