Click or drag to resize

DebuggerClient Class

Version 109.1.110
Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.
Inheritance Hierarchy

Namespace:  CefSharp.DevTools.Debugger
Assembly:  CefSharp (in CefSharp.dll) Version: 109.1.110.0 (109.1.110.0)
Syntax
public class DebuggerClient : DevToolsDomainBase

The DebuggerClient type exposes the following members.

Constructors
  NameDescription
Public methodDebuggerClient
Debugger
Top
Methods
  NameDescription
Public methodContinueToLocationAsync
Continues execution until specific location is reached.
Public methodDisableAsync
Disables debugger for given page.
Public methodDisassembleWasmModuleAsync
DisassembleWasmModule
Public methodEnableAsync
Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.
Protected methodEnumToString(Enum) (Inherited from DevToolsDomainBase.)
Protected methodEnumToString(ContentEncoding) (Inherited from DevToolsDomainBase.)
Protected methodEnumToString(CSPViolationType) (Inherited from DevToolsDomainBase.)
Protected methodEnumToString(DisabledImageType) (Inherited from DevToolsDomainBase.)
Protected methodEnumToString(PermissionType) (Inherited from DevToolsDomainBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluateOnCallFrameAsync
Evaluates expression on a given call frame.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPossibleBreakpointsAsync
Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.
Public methodGetScriptSourceAsync
Returns source for the script with given id.
Public methodGetStackTraceAsync
Returns stack trace with given `stackTraceId`.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNextWasmDisassemblyChunkAsync
Disassemble the next chunk of lines for the module corresponding to the stream. If disassembly is complete, this API will invalidate the streamId and return an empty chunk. Any subsequent calls for the now invalid stream will return errors.
Public methodPauseAsync
Stops on the next JavaScript statement.
Public methodRemoveBreakpointAsync
Removes JavaScript breakpoint.
Public methodRestartFrameAsync
Restarts particular call frame from the beginning. The old, deprecated behavior of `restartFrame` is to stay paused and allow further CDP commands after a restart was scheduled. This can cause problems with restarting, so we now continue execution immediatly after it has been scheduled until we reach the beginning of the restarted frame. To stay back-wards compatible, `restartFrame` now expects a `mode` parameter to be present. If the `mode` parameter is missing, `restartFrame` errors out. The various return values are deprecated and `callFrames` is always empty. Use the call frames from the `Debugger#paused` events instead, that fires once V8 pauses at the beginning of the restarted function.
Public methodResumeAsync
Resumes JavaScript execution.
Public methodSearchInContentAsync
Searches for given string in script content.
Public methodSetAsyncCallStackDepthAsync
Enables or disables async call stacks tracking.
Public methodSetBlackboxedRangesAsync
Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted.
Public methodSetBlackboxPatternsAsync
Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.
Public methodSetBreakpointAsync
Sets JavaScript breakpoint at a given location.
Public methodSetBreakpointByUrlAsync
Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in `locations` property. Further matching script parsing will result in subsequent `breakpointResolved` events issued. This logical breakpoint will survive page reloads.
Public methodSetBreakpointOnFunctionCallAsync
Sets JavaScript breakpoint before each call to the given function. If another function was created from the same source as a given one, calling it will also trigger the breakpoint.
Public methodSetBreakpointsActiveAsync
Activates / deactivates all breakpoints on the page.
Public methodSetInstrumentationBreakpointAsync
Sets instrumentation breakpoint.
Public methodSetPauseOnExceptionsAsync
Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions, or caught exceptions, no exceptions. Initial pause on exceptions state is `none`.
Public methodSetReturnValueAsync
Changes return value in top frame. Available only at return break position.
Public methodSetScriptSourceAsync
Edits JavaScript source live. In general, functions that are currently on the stack can not be edited with a single exception: If the edited function is the top-most stack frame and that is the only activation of that function on the stack. In this case the live edit will be successful and a `Debugger.restartFrame` for the top-most function is automatically triggered.
Public methodSetSkipAllPausesAsync
Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).
Public methodSetVariableValueAsync
Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.
Public methodStepIntoAsync
Steps into the function call.
Public methodStepOutAsync
Steps out of the function call.
Public methodStepOverAsync
Steps over the statement.
Protected methodToBase64String (Inherited from DevToolsDomainBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventBreakpointResolved
Fired when breakpoint is resolved to an actual script and location.
Public eventPaused
Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.
Public eventResumed
Fired when the virtual machine resumed execution.
Public eventScriptFailedToParse
Fired when virtual machine fails to parse the script.
Public eventScriptParsed
Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.
Top
See Also