jupyter 2.8.3 (latest) · OCaml Package

Messaging in Jupyter

type header = {

}

val header_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> header

val yojson_of_header : header -> Ppx_yojson_conv_lib.Yojson.Safe.t

val header_of_string : string -> header

val header_option_of_string : string -> header Json.option_try

val string_of_header : header -> string

val string_of_header_option : header option -> string

type 'content t = {

zmq_ids : string list;
content : 'content;
(*
The actual content of the message must be a dict, whose structure depends on the message type.
*)
header : header;
(*
The message header contains a pair of unique identifiers for the originating session and the actual message id, in addition to the username for the process that generated the message. This is useful in collaborative settings where multiple users may be interacting with the same kernel simultaneously, so that frontends can label the various messages in a meaningful way.
*)
parent_header : header option;
(*
In a chain of messages, the header from the parent is copied so that clients can track where messages come from.
*)
metadata : string;
(*
Any metadata associated with the message.
*)
buffers : string list;
(*
optional: buffers is a list of binary data buffers for implementations that support binary extensions to the protocol.
*)

}

val t_of_yojson : 
  'content. (Ppx_yojson_conv_lib.Yojson.Safe.t -> 'content) ->
  Ppx_yojson_conv_lib.Yojson.Safe.t ->
  'content t

val yojson_of_t : 
  'content. ('content -> Ppx_yojson_conv_lib.Yojson.Safe.t) ->
  'content t ->
  Ppx_yojson_conv_lib.Yojson.Safe.t

val epoch_to_iso8601_string : float -> string

val create_next : 
  ?time:float ->
  content_to_yojson:('a -> [> `List of [> `String of string ] list ]) ->
  'b t ->
  'a ->
  'a t

val create_next_shell : ?time:float -> 'a t -> Shell.reply -> Shell.reply t

val create_next_iopub : ?time:float -> 'a t -> Iopub.reply -> Iopub.reply t

val create_next_stdin : ?time:float -> 'a t -> Stdin.reply -> Stdin.reply t

type request =

val request_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> request

val yojson_of_request : request -> Ppx_yojson_conv_lib.Yojson.Safe.t

type reply =

val reply_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> reply

val yojson_of_reply : reply -> Ppx_yojson_conv_lib.Yojson.Safe.t

package jupyter