package dap

  1. Overview
  2. Docs
Debug adapter protocol

Install 

dune-project
 Dependency

github.com Edit opam file Versions (8)

Authors

  1. æ
    文宇祥 <hackwaly@qq.com>

Maintainers

  1. æ
    文宇祥 <hackwaly@qq.com>

Sources

dap-1.1.0.tbz
sha256=0b4cdef2ec61b98f73b686a6cb9cde8dde14404097f52a9367c55f1667441712
sha512=ba1897e3afa66b34ad65911dee0b433c48756a5c81467b6277cc2fc1f4360533af7c707744b87707afa9891886dcdb0f7fa7e1653807903f5bd2c1d36a4d92d0

doc/dap.rpc_lwt/Debug_rpc/index.html

Module Debug_rpcSource

Sourceval log_src : Logs.Src.t
Sourcetype t

The type of rpc connection

Sourceexception Error_with_message of Debug_protocol.Message.t

The exception used to represent command execution is failed with Message.t

Sourcetype progress = < start : unit -> unit Lwt.t ; update : int -> int -> unit Lwt.t ; finish : unit -> unit Lwt.t >
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 connection

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 set_progressive_command_handler : t -> (module Debug_protocol.COMMAND with type Arguments.t = 'a and type Result.t = 'b) -> ('a -> progress -> 'b Lwt.t) -> unit

set_command_handler rpc (module The_command) f Set handler f for The_command

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

set_command_handler rpc (module The_command) f Set handler f for The_command

Sourceval remove_command_handler : t -> (module Debug_protocol.COMMAND) -> unit

remove_command_handler rpc (module The_command) Remove handler 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