IDebugProtocolServer (org.eclipse.lsp4j.debug 0.9.0 API)

```
public interface IDebugProtocolServer
```
Declaration of server requests for the Debug Adapter Protocol

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String SCHEMA_VERSION
Version of Debug Protocol

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

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`attach(java.util.Map<java.lang.String,java.lang.Object> args)` The attach request is sent from the client to the debug adapter to attach to a debuggee that is already running.
`default java.util.concurrent.CompletableFuture<BreakpointLocationsResponse>`	`breakpointLocations(BreakpointLocationsArguments args)` The 'breakpointLocations' request returns all possible locations for source breakpoints in a given range.
`default java.util.concurrent.CompletableFuture<CompletionsResponse>`	`completions(CompletionsArguments args)` Returns a list of possible completions for a given caret position and text.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`configurationDone(ConfigurationDoneArguments args)` The client of the debug protocol must send this request at the end of the sequence of configuration requests (which was started by the 'initialized' event).
`default java.util.concurrent.CompletableFuture<ContinueResponse>`	`continue_(ContinueArguments args)` The request starts the debuggee to run again.
`default java.util.concurrent.CompletableFuture<DataBreakpointInfoResponse>`	`dataBreakpointInfo(DataBreakpointInfoArguments args)` Obtains information on a possible data breakpoint that could be set on an expression or variable.
`default java.util.concurrent.CompletableFuture<DisassembleResponse>`	`disassemble(DisassembleArguments args)` Disassembles code stored at the provided location.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`disconnect(DisconnectArguments args)` The 'disconnect' request is sent from the client to the debug adapter in order to stop debugging.
`default java.util.concurrent.CompletableFuture<EvaluateResponse>`	`evaluate(EvaluateArguments args)` Evaluates the given expression in the context of the top most stack frame.
`default java.util.concurrent.CompletableFuture<ExceptionInfoResponse>`	`exceptionInfo(ExceptionInfoArguments args)` Retrieves the details of the exception that caused this event to be raised.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`goto_(GotoArguments args)` The request sets the location where the debuggee will continue to run.
`default java.util.concurrent.CompletableFuture<GotoTargetsResponse>`	`gotoTargets(GotoTargetsArguments args)` This request retrieves the possible goto targets for the specified source location.
`default java.util.concurrent.CompletableFuture<Capabilities>`	`initialize(InitializeRequestArguments args)` The 'initialize' request is sent as the first request from the client to the debug adapter in order to configure it with client capabilities and to retrieve capabilities from the debug adapter.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`launch(java.util.Map<java.lang.String,java.lang.Object> args)` The launch request is sent from the client to the debug adapter to start the debuggee with or without debugging (if 'noDebug' is true).
`default java.util.concurrent.CompletableFuture<LoadedSourcesResponse>`	`loadedSources(LoadedSourcesArguments args)` Retrieves the set of all sources currently loaded by the debugged process.
`default java.util.concurrent.CompletableFuture<ModulesResponse>`	`modules(ModulesArguments args)` Modules can be retrieved from the debug adapter with the ModulesRequest which can either return all modules or a range of modules to support paging.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`next(NextArguments args)` The request starts the debuggee to run again for one step.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`pause(PauseArguments args)` The request suspends the debuggee.
`default java.util.concurrent.CompletableFuture<ReadMemoryResponse>`	`readMemory(ReadMemoryArguments args)` Reads bytes from memory at the provided location.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`restart(RestartArguments args)` Restarts a debug session.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`restartFrame(RestartFrameArguments args)` The request restarts execution of the specified stackframe.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`reverseContinue(ReverseContinueArguments args)` The request starts the debuggee to run backward.
`default java.util.concurrent.CompletableFuture<RunInTerminalResponse>`	`runInTerminal(RunInTerminalRequestArguments args)` This request is sent from the debug adapter to the client to run a command in a terminal.
`default java.util.concurrent.CompletableFuture<ScopesResponse>`	`scopes(ScopesArguments args)` The request returns the variable scopes for a given stackframe ID.
`default java.util.concurrent.CompletableFuture<SetBreakpointsResponse>`	`setBreakpoints(SetBreakpointsArguments args)` Sets multiple breakpoints for a single source and clears all previous breakpoints in that source.
`default java.util.concurrent.CompletableFuture<SetDataBreakpointsResponse>`	`setDataBreakpoints(SetDataBreakpointsArguments args)` Replaces all existing data breakpoints with new breakpoints.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`setExceptionBreakpoints(SetExceptionBreakpointsArguments args)` The request configures the debuggers response to thrown exceptions.
`default java.util.concurrent.CompletableFuture<SetExpressionResponse>`	`setExpression(SetExpressionArguments args)` Evaluates the given 'value' expression and assigns it to the 'expression' which must be a modifiable l-value.
`default java.util.concurrent.CompletableFuture<SetFunctionBreakpointsResponse>`	`setFunctionBreakpoints(SetFunctionBreakpointsArguments args)` Replaces all existing function breakpoints with new breakpoints.
`default java.util.concurrent.CompletableFuture<SetVariableResponse>`	`setVariable(SetVariableArguments args)` Set the variable with the given name in the variable container to a new value.
`default java.util.concurrent.CompletableFuture<SourceResponse>`	`source(SourceArguments args)` The request retrieves the source code for a given source reference.
`default java.util.concurrent.CompletableFuture<StackTraceResponse>`	`stackTrace(StackTraceArguments args)` The request returns a stacktrace from the current execution state.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`stepBack(StepBackArguments args)` The request starts the debuggee to run one step backwards.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`stepIn(StepInArguments args)` The request starts the debuggee to step into a function/method if possible.
`default java.util.concurrent.CompletableFuture<StepInTargetsResponse>`	`stepInTargets(StepInTargetsArguments args)` This request retrieves the possible stepIn targets for the specified stack frame.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`stepOut(StepOutArguments args)` The request starts the debuggee to run again for one step.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`terminate(TerminateArguments args)` The 'terminate' request is sent from the client to the debug adapter in order to give the debuggee a chance for terminating itself.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`terminateThreads(TerminateThreadsArguments args)` The request terminates the threads with the given ids.
`default java.util.concurrent.CompletableFuture<ThreadsResponse>`	`threads()` The request retrieves a list of all threads.
`default java.util.concurrent.CompletableFuture<VariablesResponse>`	`variables(VariablesArguments args)` Retrieves all child variables for the given variable reference.

- Field Detail
  - SCHEMA_VERSION
```
static final java.lang.String SCHEMA_VERSION
```
    Version of Debug Protocol
    
    See Also:
    
    Constant Field Values
- Method Detail
  - runInTerminal
```
default java.util.concurrent.CompletableFuture<RunInTerminalResponse> runInTerminal(RunInTerminalRequestArguments args)
```
    This request is sent from the debug adapter to the client to run a command in a terminal. This is typically used to launch the debuggee in a terminal provided by the client.
  - initialize
```
default java.util.concurrent.CompletableFuture<Capabilities> initialize(InitializeRequestArguments args)
```
    The 'initialize' request is sent as the first request from the client to the debug adapter in order to configure it with client capabilities and to retrieve capabilities from the debug adapter.
    Until the debug adapter has responded to with an 'initialize' response, the client must not send any additional requests or events to the debug adapter. In addition the debug adapter is not allowed to send any requests or events to the client until it has responded with an 'initialize' response.
    The 'initialize' request may only be sent once.
  - configurationDone
```
default java.util.concurrent.CompletableFuture<java.lang.Void> configurationDone(ConfigurationDoneArguments args)
```
    The client of the debug protocol must send this request at the end of the sequence of configuration requests (which was started by the 'initialized' event).
  - launch
```
default java.util.concurrent.CompletableFuture<java.lang.Void> launch(java.util.Map<java.lang.String,java.lang.Object> args)
```
    The launch request is sent from the client to the debug adapter to start the debuggee with or without debugging (if 'noDebug' is true). Since launching is debugger/runtime specific, the arguments for this request are not part of this specification.
  - attach
```
default java.util.concurrent.CompletableFuture<java.lang.Void> attach(java.util.Map<java.lang.String,java.lang.Object> args)
```
    The attach request is sent from the client to the debug adapter to attach to a debuggee that is already running. Since attaching is debugger/runtime specific, the arguments for this request are not part of this specification.
  - restart
```
default java.util.concurrent.CompletableFuture<java.lang.Void> restart(RestartArguments args)
```
    Restarts a debug session. If the capability 'supportsRestartRequest' is missing or has the value false,
    the client will implement 'restart' by terminating the debug adapter first and then launching it anew.
    A debug adapter can override this default behaviour by implementing a restart request
    and setting the capability 'supportsRestartRequest' to true.
  - disconnect
```
default java.util.concurrent.CompletableFuture<java.lang.Void> disconnect(DisconnectArguments args)
```
    The 'disconnect' request is sent from the client to the debug adapter in order to stop debugging. It asks the debug adapter to disconnect from the debuggee and to terminate the debug adapter. If the debuggee has been started with the 'launch' request, the 'disconnect' request terminates the debuggee. If the 'attach' request was used to connect to the debuggee, 'disconnect' does not terminate the debuggee. This behavior can be controlled with the 'terminateDebuggee' (if supported by the debug adapter).
  - terminate
```
default java.util.concurrent.CompletableFuture<java.lang.Void> terminate(TerminateArguments args)
```
    The 'terminate' request is sent from the client to the debug adapter in order to give the debuggee a chance for terminating itself.
  - breakpointLocations
```
default java.util.concurrent.CompletableFuture<BreakpointLocationsResponse> breakpointLocations(BreakpointLocationsArguments args)
```
    The 'breakpointLocations' request returns all possible locations for source breakpoints in a given range.
  - setBreakpoints
```
default java.util.concurrent.CompletableFuture<SetBreakpointsResponse> setBreakpoints(SetBreakpointsArguments args)
```
    Sets multiple breakpoints for a single source and clears all previous breakpoints in that source.
    To clear all breakpoint for a source, specify an empty array.
    When a breakpoint is hit, a 'stopped' event (with reason 'breakpoint') is generated.
  - setFunctionBreakpoints
```
default java.util.concurrent.CompletableFuture<SetFunctionBreakpointsResponse> setFunctionBreakpoints(SetFunctionBreakpointsArguments args)
```
    Replaces all existing function breakpoints with new breakpoints.
    To clear all function breakpoints, specify an empty array.
    When a function breakpoint is hit, a 'stopped' event (with reason 'function breakpoint') is generated.
  - setExceptionBreakpoints
```
default java.util.concurrent.CompletableFuture<java.lang.Void> setExceptionBreakpoints(SetExceptionBreakpointsArguments args)
```
    The request configures the debuggers response to thrown exceptions. If an exception is configured to break, a 'stopped' event is fired (with reason 'exception').
  - dataBreakpointInfo
```
default java.util.concurrent.CompletableFuture<DataBreakpointInfoResponse> dataBreakpointInfo(DataBreakpointInfoArguments args)
```
    Obtains information on a possible data breakpoint that could be set on an expression or variable.
  - setDataBreakpoints
```
default java.util.concurrent.CompletableFuture<SetDataBreakpointsResponse> setDataBreakpoints(SetDataBreakpointsArguments args)
```
    Replaces all existing data breakpoints with new breakpoints.
    To clear all data breakpoints, specify an empty array.
    When a data breakpoint is hit, a 'stopped' event (with reason 'data breakpoint') is generated.
  - continue_
```
default java.util.concurrent.CompletableFuture<ContinueResponse> continue_(ContinueArguments args)
```
    The request starts the debuggee to run again.
  - next
```
default java.util.concurrent.CompletableFuture<java.lang.Void> next(NextArguments args)
```
    The request starts the debuggee to run again for one step.
    The debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.
  - stepIn
```
default java.util.concurrent.CompletableFuture<java.lang.Void> stepIn(StepInArguments args)
```
    The request starts the debuggee to step into a function/method if possible.
    If it cannot step into a target, 'stepIn' behaves like 'next'.
    The debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.
    If there are multiple function/method calls (or other targets) on the source line,
    the optional argument 'targetId' can be used to control into which target the 'stepIn' should occur.
    The list of possible targets for a given source line can be retrieved via the 'stepInTargets' request.
  - stepOut
```
default java.util.concurrent.CompletableFuture<java.lang.Void> stepOut(StepOutArguments args)
```
    The request starts the debuggee to run again for one step.
    The debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.
  - stepBack
```
default java.util.concurrent.CompletableFuture<java.lang.Void> stepBack(StepBackArguments args)
```
    The request starts the debuggee to run one step backwards.
    The debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed. Clients should only call this request if the capability 'supportsStepBack' is true.
  - reverseContinue
```
default java.util.concurrent.CompletableFuture<java.lang.Void> reverseContinue(ReverseContinueArguments args)
```
    The request starts the debuggee to run backward. Clients should only call this request if the capability 'supportsStepBack' is true.
  - restartFrame
```
default java.util.concurrent.CompletableFuture<java.lang.Void> restartFrame(RestartFrameArguments args)
```
    The request restarts execution of the specified stackframe.
    The debug adapter first sends the response and then a 'stopped' event (with reason 'restart') after the restart has completed.
  - goto_
```
default java.util.concurrent.CompletableFuture<java.lang.Void> goto_(GotoArguments args)
```
    The request sets the location where the debuggee will continue to run.
    This makes it possible to skip the execution of code or to executed code again.
    The code between the current location and the goto target is not executed but skipped.
    The debug adapter first sends the response and then a 'stopped' event with reason 'goto'.
  - pause
```
default java.util.concurrent.CompletableFuture<java.lang.Void> pause(PauseArguments args)
```
    The request suspends the debuggee.
    The debug adapter first sends the response and then a 'stopped' event (with reason 'pause') after the thread has been paused successfully.
  - stackTrace
```
default java.util.concurrent.CompletableFuture<StackTraceResponse> stackTrace(StackTraceArguments args)
```
    The request returns a stacktrace from the current execution state.
  - scopes
```
default java.util.concurrent.CompletableFuture<ScopesResponse> scopes(ScopesArguments args)
```
    The request returns the variable scopes for a given stackframe ID.
  - variables
```
default java.util.concurrent.CompletableFuture<VariablesResponse> variables(VariablesArguments args)
```
    Retrieves all child variables for the given variable reference.
    An optional filter can be used to limit the fetched children to either named or indexed children.
  - setVariable
```
default java.util.concurrent.CompletableFuture<SetVariableResponse> setVariable(SetVariableArguments args)
```
    Set the variable with the given name in the variable container to a new value.
  - source
```
default java.util.concurrent.CompletableFuture<SourceResponse> source(SourceArguments args)
```
    The request retrieves the source code for a given source reference.
  - threads
```
default java.util.concurrent.CompletableFuture<ThreadsResponse> threads()
```
    The request retrieves a list of all threads.
  - terminateThreads
```
default java.util.concurrent.CompletableFuture<java.lang.Void> terminateThreads(TerminateThreadsArguments args)
```
    The request terminates the threads with the given ids.
  - modules
```
default java.util.concurrent.CompletableFuture<ModulesResponse> modules(ModulesArguments args)
```
    Modules can be retrieved from the debug adapter with the ModulesRequest which can either return all modules or a range of modules to support paging.
  - loadedSources
```
default java.util.concurrent.CompletableFuture<LoadedSourcesResponse> loadedSources(LoadedSourcesArguments args)
```
    Retrieves the set of all sources currently loaded by the debugged process.
  - evaluate
```
default java.util.concurrent.CompletableFuture<EvaluateResponse> evaluate(EvaluateArguments args)
```
    Evaluates the given expression in the context of the top most stack frame.
    The expression has access to any variables and arguments that are in scope.
  - setExpression
```
default java.util.concurrent.CompletableFuture<SetExpressionResponse> setExpression(SetExpressionArguments args)
```
    Evaluates the given 'value' expression and assigns it to the 'expression' which must be a modifiable l-value.
    The expressions have access to any variables and arguments that are in scope of the specified frame.
  - stepInTargets
```
default java.util.concurrent.CompletableFuture<StepInTargetsResponse> stepInTargets(StepInTargetsArguments args)
```
    This request retrieves the possible stepIn targets for the specified stack frame.
    These targets can be used in the 'stepIn' request.
    The StepInTargets may only be called if the 'supportsStepInTargetsRequest' capability exists and is true.
  - gotoTargets
```
default java.util.concurrent.CompletableFuture<GotoTargetsResponse> gotoTargets(GotoTargetsArguments args)
```
    This request retrieves the possible goto targets for the specified source location.
    These targets can be used in the 'goto' request.
    The GotoTargets request may only be called if the 'supportsGotoTargetsRequest' capability exists and is true.
  - completions
```
default java.util.concurrent.CompletableFuture<CompletionsResponse> completions(CompletionsArguments args)
```
    Returns a list of possible completions for a given caret position and text.
    The CompletionsRequest may only be called if the 'supportsCompletionsRequest' capability exists and is true.
  - exceptionInfo
```
default java.util.concurrent.CompletableFuture<ExceptionInfoResponse> exceptionInfo(ExceptionInfoArguments args)
```
    Retrieves the details of the exception that caused this event to be raised.
  - readMemory
```
default java.util.concurrent.CompletableFuture<ReadMemoryResponse> readMemory(ReadMemoryArguments args)
```
    Reads bytes from memory at the provided location.
  - disassemble
```
default java.util.concurrent.CompletableFuture<DisassembleResponse> disassemble(DisassembleArguments args)
```
    Disassembles code stored at the provided location.

Interface IDebugProtocolServer

Field Summary

Method Summary

Field Detail

SCHEMA_VERSION

Method Detail

runInTerminal

initialize

configurationDone

launch

attach

restart

disconnect

terminate

breakpointLocations

setBreakpoints

setFunctionBreakpoints

setExceptionBreakpoints

dataBreakpointInfo

setDataBreakpoints

continue_

next

stepIn

stepOut

stepBack

reverseContinue

restartFrame

goto_

pause

stackTrace

scopes

variables

setVariable

source

threads

terminateThreads

modules

loadedSources

evaluate

setExpression

stepInTargets

gotoTargets

completions

exceptionInfo

readMemory

disassemble