org.eclipse.lsp4j.debug.services

Interface IDebugProtocolClient

public interface IDebugProtocolClient

Declaration of client notifications for the Debug Adapter Protocol

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCHEMA_VERSION Version of Debug Protocol

Method Summary

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	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	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.

Field Detail

SCHEMA_VERSION

static final java.lang.String SCHEMA_VERSION

Version of Debug Protocol

See Also:

Constant Field Values

Method Detail

initialized

default void initialized()

This event indicates that the debug adapter is ready to accept configuration requests (e.g. SetBreakpointsRequest, SetExceptionBreakpointsRequest).

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:

• adapters sends 'initialized' event (after the 'initialize' request has returned)
• frontend sends zero or more 'setBreakpoints' requests
• frontend sends one 'setFunctionBreakpoints' request
• frontend sends a 'setExceptionBreakpoints' request if one or more 'exceptionBreakpointFilters' have been defined (or if 'supportsConfigurationDoneRequest' is not defined or false)
• frontend sends other future configuration requests
• frontend sends one 'configurationDone' request to indicate the end of the configuration.

stopped

default void stopped(StoppedEventArguments args)

The event indicates that the execution of the debuggee has stopped due to some condition.

This can be caused by a break point previously set, a stepping action has completed, by executing a debugger statement etc.

continued

default void continued(ContinuedEventArguments args)

The event indicates that the execution of the debuggee has continued.

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.

exited

default void exited(ExitedEventArguments args)

The event indicates that the debuggee has exited and returns its exit code.

terminated

default void terminated(TerminatedEventArguments args)

The event indicates that debugging of the debuggee has terminated. This does **not** mean that the debuggee itself has exited.

thread

default void thread(ThreadEventArguments args)

The event indicates that a thread has started or exited.

output

default void output(OutputEventArguments args)

The event indicates that the target has produced some output.

breakpoint

default void breakpoint(BreakpointEventArguments args)

The event indicates that some information about a breakpoint has changed.

module

default void module(ModuleEventArguments args)

The event indicates that some information about a module has changed.

loadedSource

default void loadedSource(LoadedSourceEventArguments args)

The event indicates that some source has been added, changed, or removed from the set of all loaded sources.

process

default void process(ProcessEventArguments args)

The event indicates that the debugger has begun debugging a new process. Either one that it has launched, or one that it has attached to.

capabilities

default void capabilities(CapabilitiesEventArguments args)

The event indicates that one or more capabilities have changed.

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.