package dap

  1. Overview
  2. Docs
Debug adapter protocol

Install

Dune Dependency

Authors

Maintainers

Sources

dap-1.0.0.tbz
sha256=7a670242ed251d8eb51b1690739577aa2e8dce6b6308ecdf51ec2c933c4d2910
sha512=be6e75212e1f6c1275b260802229f76fb2cc5d5eb2aa07ac9d2e21510b5dc9897e93bd126663d157a6a695c5b34e042978d41c975c4e1b7fc444577e30f9b1d0

doc/dap.rpc/Debug_rpc/index.html

Module Debug_rpcSource

Sourcetype t

The type of rpc connection

Sourceval create : in_:Lwt_io.input_channel -> out:Lwt_io.output_channel -> ?next_seq:int -> unit -> t

create ~in_ ~out ?next_seq () Create a rpc session

Sourceval event : t -> (module Debug_protocol.EVENT with type Payload.t = 'a) -> 'a React.E.t

event rpc (module The_event) Get a The_event.Payload.t React.E.t for opposite end sent events

Sourceval send_event : t -> (module Debug_protocol.EVENT with type Payload.t = 'a) -> 'a -> unit Lwt.t

send_event rpc (module The_event) payload Send event with payload to the opposite end

Sourceval register_command : t -> (module Debug_protocol.COMMAND with type Arguments.t = 'a and type Result.t = 'b) -> (t -> 'a -> string -> 'b Lwt.t) -> unit

register_command rpc (module The_command) f Register command handler f for The_command

Sourceval exec_command : t -> (module Debug_protocol.COMMAND with type Arguments.t = 'a and type Result.t = 'b) -> 'a -> 'b Lwt.t

exec_command rpc (module The_command) arg Execute The_command with arg on the opposite end.

  • returns

    res Returns promise of The_command.Result.t. You can use Lwt.cancel on it to cancel the request.

Sourceval start : t -> unit Lwt.t

start rpc Start rpc dispatch loop. You must call it before interact with rpc. This method will block until input_channel closed. You may call it in a Lwt.async block

OCaml

Innovation. Community. Security.