/usr/lib/ocaml/eliom/client/eliom_bus.mli is in libeliom-ocaml-dev 2.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | (* Ocsigen
* http://www.ocsigen.org
* Copyright (C) 2010
* Raphaël Proust
*
* 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.
*)
(** Broadcasting facilities between clients and server.
See the Eliom manual for a detailed introduction to the concept of
{% <<a_manual chapter="client-communication"|client server communication>>%}. *)
type 'a t
(** [stream b] returns the stream of datas sent to bus [b]. A new
stream is created each time this function is called. Some messages
from the bus can be lost if they were sent before the call to
[stream]. If you need to receive every message, use original stream
instead. *)
val stream : 'a t -> 'a Lwt_stream.t
(** [stream b] returns the stream of datas sent to bus [b]. A new
stream is created each time this function is called. Every
messages sent to the bus after the generation of the page are
received. This function can be called only in the onload event
handler, if called outside, it will raise a Failure. *)
val original_stream : 'a t -> 'a Lwt_stream.t
(** [write b v] send [v] to the bus [b]. Every participant of the bus
will receive [v], including the sender. *)
val write : 'a t -> 'a -> unit Lwt.t
(** after [close b], [stream b] stops receiving new messages from the
bus, but it is still possible to write to the bus. It is also
possible to close the bus by canceling a thread reading on the
stream. *)
val close : 'a t -> unit
(** To reduce traffic from the client busses try to send messages by
group. [set_queue_size bus size] set the maximum number of
messages that are accumulated before forcing a flush.
default is 20 *)
val set_queue_size : 'a t -> int -> unit
(** [set_time_before_flush bus time] set the maximum time to wait for
a new message to enqueue before flushing. Set this to a small
value to make your app more responsive, but remember that it will
consume more bandwidth. default is 0.05 second. *)
val set_time_before_flush : 'a t -> float -> unit
(**/**)
val force_link : unit
|