Google Cloud Debugger v2 API - Class Controller2.Controller2Base (3.1.0)

[BindServiceMethod(typeof(Controller2), "BindService")]
public abstract class Controller2Base

Reference documentation and code samples for the Google Cloud Debugger v2 API class Controller2.Controller2Base.

Base class for server-side implementations of Controller2

Inheritance

Object > Controller2.Controller2Base

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Debugger.V2

Assembly

Google.Cloud.Debugger.V2.dll

Methods

ListActiveBreakpoints(ListActiveBreakpointsRequest, ServerCallContext)

public virtual Task<ListActiveBreakpointsResponse> ListActiveBreakpoints(ListActiveBreakpointsRequest request, ServerCallContext context)

Returns the list of all active breakpoints for the debuggee.

The breakpoint specification (location, condition, and expressions fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics.

This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.

Parameters
Name	Description
`request`	`ListActiveBreakpointsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListActiveBreakpointsResponse>`	The response to send back to the client (wrapped by a task).

RegisterDebuggee(RegisterDebuggeeRequest, ServerCallContext)

public virtual Task<RegisterDebuggeeResponse> RegisterDebuggee(RegisterDebuggeeRequest request, ServerCallContext context)

Registers the debuggee with the controller service.

All agents attached to the same application must call this method with exactly the same request content to get back the same stable debuggee_id. Agents should call this method again whenever google.rpc.Code.NOT_FOUND is returned from any controller method.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Parameters
Name	Description
`request`	`RegisterDebuggeeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<RegisterDebuggeeResponse>`	The response to send back to the client (wrapped by a task).

UpdateActiveBreakpoint(UpdateActiveBreakpointRequest, ServerCallContext)

public virtual Task<UpdateActiveBreakpointResponse> UpdateActiveBreakpoint(UpdateActiveBreakpointRequest request, ServerCallContext context)

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the location, condition and expressions fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.

Parameters
Name	Description
`request`	`UpdateActiveBreakpointRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<UpdateActiveBreakpointResponse>`	The response to send back to the client (wrapped by a task).