probe-web / @probe-web/client / index / DebugSessionLike

Interface: DebugSessionLike

Defined in: debugger.ts:24

The subset of the SDK Session the debugger needs. It is structural so tests can pass a fake; apps pass a real session, via Session.debugger.

Properties

Property	Type	Description	Defined in
raw	{ clearCoreDebugState: Promise<void>; step: Promise<unknown>; loadDebugInfo: Promise<void>; loadSvd: Promise<void>; clearSvd: Promise<void>; richStackTrace: Promise<unknown>; scopes: Promise<unknown>; variables: Promise<unknown>; evaluate: Promise<unknown>; setVariable: Promise<unknown>; resolveSourceBreakpoints: Promise<unknown>; resolveSourceLocations: Promise<unknown>; disassemble: Promise<unknown>; rttChannels?: Promise<unknown>; pollRtt?: Promise<unknown>; }	The raw session RPCs the debugger calls (a subset of ProbeWebSession).	debugger.ts:28
raw.clearCoreDebugState	Promise<void>	-	debugger.ts:29
raw.step	Promise<unknown>	-	debugger.ts:30
raw.loadDebugInfo	Promise<void>	-	debugger.ts:31
raw.loadSvd	Promise<void>	-	debugger.ts:32
raw.clearSvd	Promise<void>	-	debugger.ts:33
raw.richStackTrace	Promise<unknown>	-	debugger.ts:34
raw.scopes	Promise<unknown>	-	debugger.ts:35
raw.variables	Promise<unknown>	-	debugger.ts:36
raw.evaluate	Promise<unknown>	-	debugger.ts:37
raw.setVariable	Promise<unknown>	-	debugger.ts:38
raw.resolveSourceBreakpoints	Promise<unknown>	-	debugger.ts:39
raw.resolveSourceLocations	Promise<unknown>	-	debugger.ts:40
raw.disassemble	Promise<unknown>	-	debugger.ts:41
raw.rttChannels?	Promise<unknown>	-	debugger.ts:42
raw.pollRtt?	Promise<unknown>	-	debugger.ts:43

Methods

targetMetadata()

targetMetadata(): Promise<WireSessionTargetMetadata>;

Defined in: debugger.ts:26

The attached chip's cores and memory map.

Returns

Promise<WireSessionTargetMetadata>

---

supports()?

optional supports(path): boolean;

Defined in: debugger.ts:46

Whether the server implements an endpoint (the SDK Session; optional so tests can omit it).

Parameters

Parameter	Type
path	keyof Endpoints

Returns

boolean

---

createRttClient()?

optional createRttClient(opts): Promise<unknown>;

Defined in: debugger.ts:48

The SDK Session's RTT setup (optional so tests can omit it).

Parameters

Parameter	Type
opts	{ elf?: Uint8Array<ArrayBufferLike>; channels?: RttChannelConfigInput[]; }
opts.elf?	Uint8Array<ArrayBufferLike>
opts.channels?	RttChannelConfigInput[]

Returns

Promise<unknown>

---

core()

core(index): DebugCoreLike;

Defined in: debugger.ts:50

The core the debugger controls.

Parameters

Parameter	Type
index	number

Returns

DebugCoreLike