Class Controller2ClientImpl

public sealed class Controller2ClientImpl : Controller2Client

Controller2 client wrapper implementation, for convenient use.

Inheritance

Object > Controller2Client > Controller2ClientImpl

Namespace

Google.Cloud.Debugger.V2

Assembly

Google.Cloud.Debugger.V2.dll

Remarks

The Controller service provides the API for orchestrating a collection of debugger agents to perform debugging tasks. These agents are each attached to a process of an application which may include one or more replicas.

The debugger agents register with the Controller to identify the application being debugged, the Debuggee. All agents that register with the same data, represent the same Debuggee, and are assigned the same debuggee_id.

The debugger agents call the Controller to retrieve the list of active Breakpoints. Agents with the same debuggee_id get the same breakpoints list. An agent that can fulfill the breakpoint request updates the Controller with the breakpoint result. The controller selects the first result received and discards the rest of the results. Agents that poll again for active breakpoints will no longer have the completed breakpoint in the list and should remove that breakpoint from their attached process.

The Controller service does not provide a way to retrieve the results of a completed breakpoint. This functionality is available using the Debugger service.

Constructors

Controller2ClientImpl(Controller2.Controller2Client, Controller2Settings)

public Controller2ClientImpl(Controller2.Controller2Client grpcClient, Controller2Settings settings)

Constructs a client wrapper for the Controller2 service, with the specified gRPC client and settings.

Parameters
TypeNameDescription
Controller2.Controller2ClientgrpcClient

The underlying gRPC client.

Controller2Settingssettings

The base Controller2Settings used within this client.

Properties

GrpcClient

public override Controller2.Controller2Client GrpcClient { get; }

The underlying gRPC Controller2 client

Property Value
TypeDescription
Controller2.Controller2Client
Overrides

Methods

ListActiveBreakpoints(ListActiveBreakpointsRequest, CallSettings)

public override ListActiveBreakpointsResponse ListActiveBreakpoints(ListActiveBreakpointsRequest request, CallSettings callSettings = null)

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
TypeNameDescription
ListActiveBreakpointsRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListActiveBreakpointsResponse

The RPC response.

Overrides

ListActiveBreakpointsAsync(ListActiveBreakpointsRequest, CallSettings)

public override Task<ListActiveBreakpointsResponse> ListActiveBreakpointsAsync(ListActiveBreakpointsRequest request, CallSettings callSettings = null)

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
TypeNameDescription
ListActiveBreakpointsRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ListActiveBreakpointsResponse>

A Task containing the RPC response.

Overrides

RegisterDebuggee(RegisterDebuggeeRequest, CallSettings)

public override RegisterDebuggeeResponse RegisterDebuggee(RegisterDebuggeeRequest request, CallSettings callSettings = null)

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
TypeNameDescription
RegisterDebuggeeRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
RegisterDebuggeeResponse

The RPC response.

Overrides

RegisterDebuggeeAsync(RegisterDebuggeeRequest, CallSettings)

public override Task<RegisterDebuggeeResponse> RegisterDebuggeeAsync(RegisterDebuggeeRequest request, CallSettings callSettings = null)

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
TypeNameDescription
RegisterDebuggeeRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<RegisterDebuggeeResponse>

A Task containing the RPC response.

Overrides

UpdateActiveBreakpoint(UpdateActiveBreakpointRequest, CallSettings)

public override UpdateActiveBreakpointResponse UpdateActiveBreakpoint(UpdateActiveBreakpointRequest request, CallSettings callSettings = null)

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
TypeNameDescription
UpdateActiveBreakpointRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UpdateActiveBreakpointResponse

The RPC response.

Overrides

UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest, CallSettings)

public override Task<UpdateActiveBreakpointResponse> UpdateActiveBreakpointAsync(UpdateActiveBreakpointRequest request, CallSettings callSettings = null)

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
TypeNameDescription
UpdateActiveBreakpointRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<UpdateActiveBreakpointResponse>

A Task containing the RPC response.

Overrides