public interface IDebugProtocolClient
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SCHEMA_VERSION
Version of Debug Protocol
|
Modifier and Type | Method and Description |
---|---|
default void |
breakpoint(BreakpointEventArguments args)
The event indicates that some information about a breakpoint has changed.
|
default void |
capabilities(CapabilitiesEventArguments args)
The event indicates that one or more capabilities have changed.
|
default void |
continued(ContinuedEventArguments args)
The event indicates that the execution of the debuggee has continued.
|
default void |
exited(ExitedEventArguments args)
The event indicates that the debuggee has exited and returns its exit code.
|
default void |
initialized()
This event indicates that the debug adapter is ready to accept configuration
requests (e.g.
|
default void |
invalidated(InvalidatedEventArguments args)
This event signals that some state in the debug adapter has changed and
requires that the client needs to re-render the data snapshot previously
requested.
|
default void |
loadedSource(LoadedSourceEventArguments args)
The event indicates that some source has been added, changed, or removed from
the set of all loaded sources.
|
default void |
module(ModuleEventArguments args)
The event indicates that some information about a module has changed.
|
default void |
output(OutputEventArguments args)
The event indicates that the target has produced some output.
|
default void |
process(ProcessEventArguments args)
The event indicates that the debugger has begun debugging a new process.
|
default void |
progressEnd(ProgressEndEventArguments args)
The event signals the end of the progress reporting with an optional final
message.
|
default void |
progressStart(ProgressStartEventArguments args)
The event signals that a long running operation is about to start and
|
default void |
progressUpdate(ProgressUpdateEventArguments args)
The event signals that the progress reporting needs to updated with a new
message and/or percentage.
|
default void |
stopped(StoppedEventArguments args)
The event indicates that the execution of the debuggee has stopped due to
some condition.
|
default void |
terminated(TerminatedEventArguments args)
The event indicates that debugging of the debuggee has terminated.
|
default void |
thread(ThreadEventArguments args)
The event indicates that a thread has started or exited.
|
static final java.lang.String SCHEMA_VERSION
default void initialized()
A debug adapter is expected to send this event when it is ready to accept configuration requests (but not before the 'initialize' request has finished).
The sequence of events/requests is as follows:
default void stopped(StoppedEventArguments args)
This can be caused by a break point previously set, a stepping request has completed, by executing a debugger statement etc.
default void continued(ContinuedEventArguments args)
Please note: a debug adapter is not expected to send this event in response to a request that implies that execution continues, e.g. 'launch' or 'continue'.
It is only necessary to send a 'continued' event if there was no previous request that implied this.
default void exited(ExitedEventArguments args)
default void terminated(TerminatedEventArguments args)
default void thread(ThreadEventArguments args)
default void output(OutputEventArguments args)
default void breakpoint(BreakpointEventArguments args)
default void module(ModuleEventArguments args)
default void loadedSource(LoadedSourceEventArguments args)
default void process(ProcessEventArguments args)
default void capabilities(CapabilitiesEventArguments args)
Since the capabilities are dependent on the frontend and its UI, it might not be possible to change that at random times (or too late).
Consequently this event has a hint characteristic: a frontend can only be expected to make a 'best effort' in honouring individual capabilities but there are no guarantees.
Only changed capabilities need to be included, all other capabilities keep their values.
default void progressStart(ProgressStartEventArguments args)
provides additional information for the client to set up a corresponding progress and cancellation UI.
The client is free to delay the showing of the UI in order to reduce flicker.
This event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.
default void progressUpdate(ProgressUpdateEventArguments args)
The client does not have to update the UI immediately, but the clients needs to keep track of the message and/or percentage values.
This event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.
default void progressEnd(ProgressEndEventArguments args)
This event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.
default void invalidated(InvalidatedEventArguments args)
Debug adapters do not have to emit this event for runtime changes like stopped or thread events because in that case the client refetches the new state anyway. But the event can be used for example to refresh the UI after rendering formatting has changed in the debug adapter.
This event should only be sent if the debug adapter has received a value true for the 'supportsInvalidatedEvent' capability of the 'initialize' request.