Module `Js_top_worker_client_msg`Source

Worker client using the message protocol.

This client communicates with the OCaml toplevel worker using a simple JSON message protocol instead of RPC.

module Brr_worker = Brr_webworkers.Worker

module Brr_message = Brr_io.Message

Sourcemodule Msg = Js_top_worker_message.Message

Sourcetype output_at = {

cell_id : int;
loc : int;
(*
Character position after phrase (pos_cnum)
*)
caml_ppf : string;
mime_vals : Msg.mime_val list;

}

Incremental output from a single phrase

Sourcetype output = {

cell_id : int;
stdout : string;
stderr : string;
caml_ppf : string;
mime_vals : Msg.mime_val list;

}

Output result type

Sourcetype eval_event =

| Phrase of Js_top_worker_client_msg.output_at
(*
Incremental output after each phrase
*)
| Done of Js_top_worker_client_msg.output
(*
Final result
*)
| Error of string
(*
Error occurred
*)

Eval stream event

Sourcetype t = {

worker : Brr_worker.t;
timeout : int;
mutable cell_id : int;
mutable ready : bool;
ready_waiters : (unit -> unit) Stdlib.Queue.t;
pending : (int, Msg.worker_msg Lwt.u) Stdlib.Hashtbl.t;
pending_env : (string, Msg.worker_msg Lwt.u) Stdlib.Hashtbl.t;
pending_stream : (int, Js_top_worker_client_msg.eval_event option -> unit) Stdlib.Hashtbl.t;
mutable on_widget_update : (string -> Js_of_ocaml.Js.Unsafe.any -> unit) option;
mutable on_widget_clear : (string -> unit) option;
mutable on_widget_config : (string -> string -> unit) option;
mutable on_widget_command : (string -> string -> string -> unit) option;
mutable on_widget_register_adapter : (string -> string -> unit) option;

}

Client state

Sourceexception Timeout

Sourceexception InitError of string

Sourceexception EvalError of string

Sourceval json_global : 'a Js_of_ocaml.Js.t

Use plain JSON.stringify/JSON.parse for cross-jsoo-version compatibility.

Sourceval plain_stringify : 't1 -> 'res

Sourceval plain_parse : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t -> 'res

Sourceval parse_worker_msg : string -> Msg.worker_msg

Parse a worker message from JSON string

Source

val handle_message : 
  Js_top_worker_client_msg.t ->
  Brr_message.Ev.t Brr.Ev.t ->
  unit

Handle incoming message from worker

Sourceval create : ?timeout:int -> string -> Js_top_worker_client_msg.t

Create a new worker client.

parameter timeout
Timeout in milliseconds (default: 30000)

Sourceval next_cell_id : Js_top_worker_client_msg.t -> int

Get next cell ID

Source

val send : 
  Js_top_worker_client_msg.t ->
  [< `Complete of 'a * string * string * 'b * string option
  | `CreateEnv of string
  | `DestroyEnv of string
  | `Errors of 'c * string * string * string option
  | `Eval of 'd * string * string
  | `Init of Msg.init_config
  | `TypeAt of 'e * string * string * 'f * string option ] ->
  unit

Send a message to the worker

Sourceval wait_ready : Js_top_worker_client_msg.t -> unit Lwt.t

Wait for the worker to be ready

Sourceval init : Js_top_worker_client_msg.t -> Msg.init_config -> unit Lwt.t

Initialize the worker

Source

val eval : 
  Js_top_worker_client_msg.t ->
  ?env_id:string ->
  string ->
  Js_top_worker_client_msg.output Lwt.t

Evaluate OCaml code

Source

val eval_stream : 
  Js_top_worker_client_msg.t ->
  ?env_id:string ->
  string ->
  Js_top_worker_client_msg.eval_event Lwt_stream.t

Evaluate OCaml code with streaming output. Returns a stream of events: Phrase for each phrase as it executes, then Done with the final result, or Error if evaluation fails.

Source

val complete : 
  Js_top_worker_client_msg.t ->
  ?filename:string ->
  ?env_id:string ->
  string ->
  'a ->
  Msg.completions Lwt.t

Get completions

Source

val type_at : 
  Js_top_worker_client_msg.t ->
  ?filename:string ->
  ?env_id:string ->
  string ->
  'a ->
  Msg.type_info list Lwt.t

Get type at position

Source

val errors : 
  Js_top_worker_client_msg.t ->
  ?filename:string ->
  ?env_id:string ->
  string ->
  Msg.error list Lwt.t

Get errors

Sourceval create_env : Js_top_worker_client_msg.t -> string -> unit Lwt.t

Create environment

Sourceval destroy_env : Js_top_worker_client_msg.t -> string -> unit Lwt.t

Destroy environment

Source

val set_on_widget_update : 
  Js_top_worker_client_msg.t ->
  (string -> Js_of_ocaml.Js.Unsafe.any -> unit) ->
  unit

Set callback for widget update messages. The callback receives (widget_id, raw_view_json) where raw_view_json is the unparsed JS object for the view node.

Source

val set_on_widget_clear : 
  Js_top_worker_client_msg.t ->
  (string -> unit) ->
  unit

Set callback for widget clear messages.

Source

val set_on_widget_config : 
  Js_top_worker_client_msg.t ->
  (string -> string -> unit) ->
  unit

Set callback for widget config messages.

Source

val set_on_widget_command : 
  Js_top_worker_client_msg.t ->
  (string -> string -> string -> unit) ->
  unit

Set callback for widget command messages.

Source

val set_on_widget_register_adapter : 
  Js_top_worker_client_msg.t ->
  (string -> string -> unit) ->
  unit

Set callback for widget adapter registration messages.

Source

val send_widget_event : 
  Js_top_worker_client_msg.t ->
  widget_id:string ->
  handler_id:string ->
  event_type:string ->
  value:string option ->
  unit

Send a widget event back to the worker.

Sourceval terminate : Js_top_worker_client_msg.t -> unit

Terminate the worker

Module Js_top_worker_client_msgSource

Module `Js_top_worker_client_msg`Source