Package clouddebugger
Overview ▹
Index ▹
Variables
var Breakpoint_Action_name = map[int32]string{ 0: "CAPTURE", 1: "LOG", }
var Breakpoint_Action_value = map[string]int32{ "CAPTURE": 0, "LOG": 1, }
var Breakpoint_LogLevel_name = map[int32]string{ 0: "INFO", 1: "WARNING", 2: "ERROR", }
var Breakpoint_LogLevel_value = map[string]int32{ "INFO": 0, "WARNING": 1, "ERROR": 2, }
var StatusMessage_Reference_name = map[int32]string{ 0: "UNSPECIFIED", 3: "BREAKPOINT_SOURCE_LOCATION", 4: "BREAKPOINT_CONDITION", 7: "BREAKPOINT_EXPRESSION", 8: "BREAKPOINT_AGE", 5: "VARIABLE_NAME", 6: "VARIABLE_VALUE", }
var StatusMessage_Reference_value = map[string]int32{ "UNSPECIFIED": 0, "BREAKPOINT_SOURCE_LOCATION": 3, "BREAKPOINT_CONDITION": 4, "BREAKPOINT_EXPRESSION": 7, "BREAKPOINT_AGE": 8, "VARIABLE_NAME": 5, "VARIABLE_VALUE": 6, }
func RegisterController2Server ¶
func RegisterController2Server(s *grpc.Server, srv Controller2Server)
func RegisterDebugger2Server ¶
func RegisterDebugger2Server(s *grpc.Server, srv Debugger2Server)
type Breakpoint ¶
Represents the breakpoint specification, status and results.
type Breakpoint struct { // Breakpoint identifier, unique in the scope of the debuggee. Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Action that the agent should perform when the code at the // breakpoint location is hit. Action Breakpoint_Action `protobuf:"varint,13,opt,name=action,enum=google.devtools.clouddebugger.v2.Breakpoint_Action" json:"action,omitempty"` // Breakpoint source location. Location *SourceLocation `protobuf:"bytes,2,opt,name=location" json:"location,omitempty"` // Condition that triggers the breakpoint. // The condition is a compound boolean expression composed using expressions // in a programming language at the source location. Condition string `protobuf:"bytes,3,opt,name=condition" json:"condition,omitempty"` // List of read-only expressions to evaluate at the breakpoint location. // The expressions are composed using expressions in the programming language // at the source location. If the breakpoint action is `LOG`, the evaluated // expressions are included in log statements. Expressions []string `protobuf:"bytes,4,rep,name=expressions" json:"expressions,omitempty"` // Only relevant when action is `LOG`. Defines the message to log when // the breakpoint hits. The message may include parameter placeholders `$0`, // `$1`, etc. These placeholders are replaced with the evaluated value // of the appropriate expression. Expressions not referenced in // `log_message_format` are not logged. // // Example: `Message received, id = $0, count = $1` with // `expressions` = `[ message.id, message.count ]`. LogMessageFormat string `protobuf:"bytes,14,opt,name=log_message_format,json=logMessageFormat" json:"log_message_format,omitempty"` // Indicates the severity of the log. Only relevant when action is `LOG`. LogLevel Breakpoint_LogLevel `protobuf:"varint,15,opt,name=log_level,json=logLevel,enum=google.devtools.clouddebugger.v2.Breakpoint_LogLevel" json:"log_level,omitempty"` // When true, indicates that this is a final result and the // breakpoint state will not change from here on. IsFinalState bool `protobuf:"varint,5,opt,name=is_final_state,json=isFinalState" json:"is_final_state,omitempty"` // Time this breakpoint was created by the server in seconds resolution. CreateTime *google_protobuf1.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime" json:"create_time,omitempty"` // Time this breakpoint was finalized as seen by the server in seconds // resolution. FinalTime *google_protobuf1.Timestamp `protobuf:"bytes,12,opt,name=final_time,json=finalTime" json:"final_time,omitempty"` // E-mail address of the user that created this breakpoint UserEmail string `protobuf:"bytes,16,opt,name=user_email,json=userEmail" json:"user_email,omitempty"` // Breakpoint status. // // The status includes an error flag and a human readable message. // This field is usually unset. The message can be either // informational or an error message. Regardless, clients should always // display the text message back to the user. // // Error status indicates complete failure of the breakpoint. // // Example (non-final state): `Still loading symbols...` // // Examples (final state): // // * `Invalid line number` referring to location // * `Field f not found in class C` referring to condition Status *StatusMessage `protobuf:"bytes,10,opt,name=status" json:"status,omitempty"` // The stack at breakpoint time. StackFrames []*StackFrame `protobuf:"bytes,7,rep,name=stack_frames,json=stackFrames" json:"stack_frames,omitempty"` // Values of evaluated expressions at breakpoint time. // The evaluated expressions appear in exactly the same order they // are listed in the `expressions` field. // The `name` field holds the original expression text, the `value` or // `members` field holds the result of the evaluated expression. // If the expression cannot be evaluated, the `status` inside the `Variable` // will indicate an error and contain the error text. EvaluatedExpressions []*Variable `protobuf:"bytes,8,rep,name=evaluated_expressions,json=evaluatedExpressions" json:"evaluated_expressions,omitempty"` // The `variable_table` exists to aid with computation, memory and network // traffic optimization. It enables storing a variable once and reference // it from multiple variables, including variables stored in the // `variable_table` itself. // For example, the same `this` object, which may appear at many levels of // the stack, can have all of its data stored once in this table. The // stack frame variables then would hold only a reference to it. // // The variable `var_table_index` field is an index into this repeated field. // The stored objects are nameless and get their name from the referencing // variable. The effective variable is a merge of the referencing variable // and the referenced variable. VariableTable []*Variable `protobuf:"bytes,9,rep,name=variable_table,json=variableTable" json:"variable_table,omitempty"` // A set of custom breakpoint properties, populated by the agent, to be // displayed to the user. Labels map[string]string `protobuf:"bytes,17,rep,name=labels" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"` }
func (*Breakpoint) Descriptor ¶
func (*Breakpoint) Descriptor() ([]byte, []int)
func (*Breakpoint) GetAction ¶
func (m *Breakpoint) GetAction() Breakpoint_Action
func (*Breakpoint) GetCondition ¶
func (m *Breakpoint) GetCondition() string
func (*Breakpoint) GetCreateTime ¶
func (m *Breakpoint) GetCreateTime() *google_protobuf1.Timestamp
func (*Breakpoint) GetEvaluatedExpressions ¶
func (m *Breakpoint) GetEvaluatedExpressions() []*Variable
func (*Breakpoint) GetExpressions ¶
func (m *Breakpoint) GetExpressions() []string
func (*Breakpoint) GetFinalTime ¶
func (m *Breakpoint) GetFinalTime() *google_protobuf1.Timestamp
func (*Breakpoint) GetId ¶
func (m *Breakpoint) GetId() string
func (*Breakpoint) GetIsFinalState ¶
func (m *Breakpoint) GetIsFinalState() bool
func (*Breakpoint) GetLabels ¶
func (m *Breakpoint) GetLabels() map[string]string
func (*Breakpoint) GetLocation ¶
func (m *Breakpoint) GetLocation() *SourceLocation
func (*Breakpoint) GetLogLevel ¶
func (m *Breakpoint) GetLogLevel() Breakpoint_LogLevel
func (*Breakpoint) GetLogMessageFormat ¶
func (m *Breakpoint) GetLogMessageFormat() string
func (*Breakpoint) GetStackFrames ¶
func (m *Breakpoint) GetStackFrames() []*StackFrame
func (*Breakpoint) GetStatus ¶
func (m *Breakpoint) GetStatus() *StatusMessage
func (*Breakpoint) GetUserEmail ¶
func (m *Breakpoint) GetUserEmail() string
func (*Breakpoint) GetVariableTable ¶
func (m *Breakpoint) GetVariableTable() []*Variable
func (*Breakpoint) ProtoMessage ¶
func (*Breakpoint) ProtoMessage()
func (*Breakpoint) Reset ¶
func (m *Breakpoint) Reset()
func (*Breakpoint) String ¶
func (m *Breakpoint) String() string
type Breakpoint_Action ¶
Actions that can be taken when a breakpoint hits. Agents should reject breakpoints with unsupported or unknown action values.
type Breakpoint_Action int32
const ( // Capture stack frame and variables and update the breakpoint. // The data is only captured once. After that the breakpoint is set // in a final state. Breakpoint_CAPTURE Breakpoint_Action = 0 // Log each breakpoint hit. The breakpoint remains active until // deleted or expired. Breakpoint_LOG Breakpoint_Action = 1 )
func (Breakpoint_Action) EnumDescriptor ¶
func (Breakpoint_Action) EnumDescriptor() ([]byte, []int)
func (Breakpoint_Action) String ¶
func (x Breakpoint_Action) String() string
type Breakpoint_LogLevel ¶
Log severity levels.
type Breakpoint_LogLevel int32
const ( // Information log message. Breakpoint_INFO Breakpoint_LogLevel = 0 // Warning log message. Breakpoint_WARNING Breakpoint_LogLevel = 1 // Error log message. Breakpoint_ERROR Breakpoint_LogLevel = 2 )
func (Breakpoint_LogLevel) EnumDescriptor ¶
func (Breakpoint_LogLevel) EnumDescriptor() ([]byte, []int)
func (Breakpoint_LogLevel) String ¶
func (x Breakpoint_LogLevel) String() string
type Controller2Client ¶
type Controller2Client interface { // Registers the debuggee with the controller service. // // All agents attached to the same application should call this method with // 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 allows the controller service to disable the agent or recover from any // data loss. If the debuggee is disabled by the server, the response will // have `is_disabled` set to `true`. RegisterDebuggee(ctx context.Context, in *RegisterDebuggeeRequest, opts ...grpc.CallOption) (*RegisterDebuggeeResponse, error) // Returns the list of all active breakpoints for the debuggee. // // The breakpoint specification (location, condition, and expression // 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. ListActiveBreakpoints(ctx context.Context, in *ListActiveBreakpointsRequest, opts ...grpc.CallOption) (*ListActiveBreakpointsResponse, error) // 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 `expression` 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. UpdateActiveBreakpoint(ctx context.Context, in *UpdateActiveBreakpointRequest, opts ...grpc.CallOption) (*UpdateActiveBreakpointResponse, error) }
func NewController2Client ¶
func NewController2Client(cc *grpc.ClientConn) Controller2Client
type Controller2Server ¶
type Controller2Server interface { // Registers the debuggee with the controller service. // // All agents attached to the same application should call this method with // 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 allows the controller service to disable the agent or recover from any // data loss. If the debuggee is disabled by the server, the response will // have `is_disabled` set to `true`. RegisterDebuggee(context.Context, *RegisterDebuggeeRequest) (*RegisterDebuggeeResponse, error) // Returns the list of all active breakpoints for the debuggee. // // The breakpoint specification (location, condition, and expression // 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. ListActiveBreakpoints(context.Context, *ListActiveBreakpointsRequest) (*ListActiveBreakpointsResponse, error) // 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 `expression` 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. UpdateActiveBreakpoint(context.Context, *UpdateActiveBreakpointRequest) (*UpdateActiveBreakpointResponse, error) }
type Debuggee ¶
Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same field values when registering.
type Debuggee struct { // Unique identifier for the debuggee generated by the controller service. Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Project the debuggee is associated with. // Use the project number when registering a Google Cloud Platform project. Project string `protobuf:"bytes,2,opt,name=project" json:"project,omitempty"` // Debuggee uniquifier within the project. // Any string that identifies the application within the project can be used. // Including environment and version or build IDs is recommended. Uniquifier string `protobuf:"bytes,3,opt,name=uniquifier" json:"uniquifier,omitempty"` // Human readable description of the debuggee. // Including a human-readable project name, environment name and version // information is recommended. Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"` // If set to `true`, indicates that the debuggee is considered as inactive by // the Controller service. IsInactive bool `protobuf:"varint,5,opt,name=is_inactive,json=isInactive" json:"is_inactive,omitempty"` // Version ID of the agent release. The version ID is structured as // following: `domain/type/vmajor.minor` (for example // `google.com/gcp-java/v1.1`). AgentVersion string `protobuf:"bytes,6,opt,name=agent_version,json=agentVersion" json:"agent_version,omitempty"` // If set to `true`, indicates that the agent should disable itself and // detach from the debuggee. IsDisabled bool `protobuf:"varint,7,opt,name=is_disabled,json=isDisabled" json:"is_disabled,omitempty"` // Human readable message to be displayed to the user about this debuggee. // Absence of this field indicates no status. The message can be either // informational or an error status. Status *StatusMessage `protobuf:"bytes,8,opt,name=status" json:"status,omitempty"` // References to the locations and revisions of the source code used in the // deployed application. // // NOTE: This field is deprecated. Consumers should use // `ext_source_contexts` if it is not empty. Debug agents should populate // both this field and `ext_source_contexts`. SourceContexts []*google_devtools_source_v1.SourceContext `protobuf:"bytes,9,rep,name=source_contexts,json=sourceContexts" json:"source_contexts,omitempty"` // References to the locations and revisions of the source code used in the // deployed application. // // Contexts describing a remote repo related to the source code // have a `category` label of `remote_repo`. Source snapshot source // contexts have a `category` of `snapshot`. ExtSourceContexts []*google_devtools_source_v1.ExtendedSourceContext `protobuf:"bytes,13,rep,name=ext_source_contexts,json=extSourceContexts" json:"ext_source_contexts,omitempty"` // A set of custom debuggee properties, populated by the agent, to be // displayed to the user. Labels map[string]string `protobuf:"bytes,11,rep,name=labels" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"` }
func (*Debuggee) Descriptor ¶
func (*Debuggee) Descriptor() ([]byte, []int)
func (*Debuggee) GetAgentVersion ¶
func (m *Debuggee) GetAgentVersion() string
func (*Debuggee) GetDescription ¶
func (m *Debuggee) GetDescription() string
func (*Debuggee) GetExtSourceContexts ¶
func (m *Debuggee) GetExtSourceContexts() []*google_devtools_source_v1.ExtendedSourceContext
func (*Debuggee) GetId ¶
func (m *Debuggee) GetId() string
func (*Debuggee) GetIsDisabled ¶
func (m *Debuggee) GetIsDisabled() bool
func (*Debuggee) GetIsInactive ¶
func (m *Debuggee) GetIsInactive() bool
func (*Debuggee) GetLabels ¶
func (m *Debuggee) GetLabels() map[string]string
func (*Debuggee) GetProject ¶
func (m *Debuggee) GetProject() string
func (*Debuggee) GetSourceContexts ¶
func (m *Debuggee) GetSourceContexts() []*google_devtools_source_v1.SourceContext
func (*Debuggee) GetStatus ¶
func (m *Debuggee) GetStatus() *StatusMessage
func (*Debuggee) GetUniquifier ¶
func (m *Debuggee) GetUniquifier() string
func (*Debuggee) ProtoMessage ¶
func (*Debuggee) ProtoMessage()
func (*Debuggee) Reset ¶
func (m *Debuggee) Reset()
func (*Debuggee) String ¶
func (m *Debuggee) String() string
type Debugger2Client ¶
type Debugger2Client interface { // Sets the breakpoint to the debuggee. SetBreakpoint(ctx context.Context, in *SetBreakpointRequest, opts ...grpc.CallOption) (*SetBreakpointResponse, error) // Gets breakpoint information. GetBreakpoint(ctx context.Context, in *GetBreakpointRequest, opts ...grpc.CallOption) (*GetBreakpointResponse, error) // Deletes the breakpoint from the debuggee. DeleteBreakpoint(ctx context.Context, in *DeleteBreakpointRequest, opts ...grpc.CallOption) (*google_protobuf3.Empty, error) // Lists all breakpoints for the debuggee. ListBreakpoints(ctx context.Context, in *ListBreakpointsRequest, opts ...grpc.CallOption) (*ListBreakpointsResponse, error) // Lists all the debuggees that the user can set breakpoints to. ListDebuggees(ctx context.Context, in *ListDebuggeesRequest, opts ...grpc.CallOption) (*ListDebuggeesResponse, error) }
func NewDebugger2Client ¶
func NewDebugger2Client(cc *grpc.ClientConn) Debugger2Client
type Debugger2Server ¶
type Debugger2Server interface { // Sets the breakpoint to the debuggee. SetBreakpoint(context.Context, *SetBreakpointRequest) (*SetBreakpointResponse, error) // Gets breakpoint information. GetBreakpoint(context.Context, *GetBreakpointRequest) (*GetBreakpointResponse, error) // Deletes the breakpoint from the debuggee. DeleteBreakpoint(context.Context, *DeleteBreakpointRequest) (*google_protobuf3.Empty, error) // Lists all breakpoints for the debuggee. ListBreakpoints(context.Context, *ListBreakpointsRequest) (*ListBreakpointsResponse, error) // Lists all the debuggees that the user can set breakpoints to. ListDebuggees(context.Context, *ListDebuggeesRequest) (*ListDebuggeesResponse, error) }
type DeleteBreakpointRequest ¶
Request to delete a breakpoint.
type DeleteBreakpointRequest struct { // ID of the debuggee whose breakpoint to delete. DebuggeeId string `protobuf:"bytes,1,opt,name=debuggee_id,json=debuggeeId" json:"debuggee_id,omitempty"` // ID of the breakpoint to delete. BreakpointId string `protobuf:"bytes,2,opt,name=breakpoint_id,json=breakpointId" json:"breakpoint_id,omitempty"` // The client version making the call. // Following: `domain/type/version` (e.g., `google.com/intellij/v1`). ClientVersion string `protobuf:"bytes,3,opt,name=client_version,json=clientVersion" json:"client_version,omitempty"` }
func (*DeleteBreakpointRequest) Descriptor ¶
func (*DeleteBreakpointRequest) Descriptor() ([]byte, []int)
func (*DeleteBreakpointRequest) GetBreakpointId ¶
func (m *DeleteBreakpointRequest) GetBreakpointId() string
func (*DeleteBreakpointRequest) GetClientVersion ¶
func (m *DeleteBreakpointRequest) GetClientVersion() string
func (*DeleteBreakpointRequest) GetDebuggeeId ¶
func (m *DeleteBreakpointRequest) GetDebuggeeId() string
func (*DeleteBreakpointRequest) ProtoMessage ¶
func (*DeleteBreakpointRequest) ProtoMessage()
func (*DeleteBreakpointRequest) Reset ¶
func (m *DeleteBreakpointRequest) Reset()
func (*DeleteBreakpointRequest) String ¶
func (m *DeleteBreakpointRequest) String() string
type FormatMessage ¶
Represents a message with parameters.
type FormatMessage struct { // Format template for the message. The `format` uses placeholders `$0`, // `$1`, etc. to reference parameters. `$$` can be used to denote the `$` // character. // // Examples: // // * `Failed to load '$0' which helps debug $1 the first time it // is loaded. Again, $0 is very important.` // * `Please pay $$10 to use $0 instead of $1.` Format string `protobuf:"bytes,1,opt,name=format" json:"format,omitempty"` // Optional parameters to be embedded into the message. Parameters []string `protobuf:"bytes,2,rep,name=parameters" json:"parameters,omitempty"` }
func (*FormatMessage) Descriptor ¶
func (*FormatMessage) Descriptor() ([]byte, []int)
func (*FormatMessage) GetFormat ¶
func (m *FormatMessage) GetFormat() string
func (*FormatMessage) GetParameters ¶
func (m *FormatMessage) GetParameters() []string
func (*FormatMessage) ProtoMessage ¶
func (*FormatMessage) ProtoMessage()
func (*FormatMessage) Reset ¶
func (m *FormatMessage) Reset()
func (*FormatMessage) String ¶
func (m *FormatMessage) String() string
type GetBreakpointRequest ¶
Request to get breakpoint information.
type GetBreakpointRequest struct { // ID of the debuggee whose breakpoint to get. DebuggeeId string `protobuf:"bytes,1,opt,name=debuggee_id,json=debuggeeId" json:"debuggee_id,omitempty"` // ID of the breakpoint to get. BreakpointId string `protobuf:"bytes,2,opt,name=breakpoint_id,json=breakpointId" json:"breakpoint_id,omitempty"` // The client version making the call. // Following: `domain/type/version` (e.g., `google.com/intellij/v1`). ClientVersion string `protobuf:"bytes,4,opt,name=client_version,json=clientVersion" json:"client_version,omitempty"` }
func (*GetBreakpointRequest) Descriptor ¶
func (*GetBreakpointRequest) Descriptor() ([]byte, []int)
func (*GetBreakpointRequest) GetBreakpointId ¶
func (m *GetBreakpointRequest) GetBreakpointId() string
func (*GetBreakpointRequest) GetClientVersion ¶
func (m *GetBreakpointRequest) GetClientVersion() string
func (*GetBreakpointRequest) GetDebuggeeId ¶
func (m *GetBreakpointRequest) GetDebuggeeId() string
func (*GetBreakpointRequest) ProtoMessage ¶
func (*GetBreakpointRequest) ProtoMessage()
func (*GetBreakpointRequest) Reset ¶
func (m *GetBreakpointRequest) Reset()
func (*GetBreakpointRequest) String ¶
func (m *GetBreakpointRequest) String() string
type GetBreakpointResponse ¶
Response for getting breakpoint information.
type GetBreakpointResponse struct { // Complete breakpoint state. // The fields `id` and `location` are guaranteed to be set. Breakpoint *Breakpoint `protobuf:"bytes,1,opt,name=breakpoint" json:"breakpoint,omitempty"` }
func (*GetBreakpointResponse) Descriptor ¶
func (*GetBreakpointResponse) Descriptor() ([]byte, []int)
func (*GetBreakpointResponse) GetBreakpoint ¶
func (m *GetBreakpointResponse) GetBreakpoint() *Breakpoint
func (*GetBreakpointResponse) ProtoMessage ¶
func (*GetBreakpointResponse) ProtoMessage()
func (*GetBreakpointResponse) Reset ¶
func (m *GetBreakpointResponse) Reset()
func (*GetBreakpointResponse) String ¶
func (m *GetBreakpointResponse) String() string
type ListActiveBreakpointsRequest ¶
Request to list active breakpoints.
type ListActiveBreakpointsRequest struct { // Identifies the debuggee. DebuggeeId string `protobuf:"bytes,1,opt,name=debuggee_id,json=debuggeeId" json:"debuggee_id,omitempty"` // A wait token that, if specified, blocks the method call until the list // of active breakpoints has changed, or a server selected timeout has // expired. The value should be set from the last returned response. WaitToken string `protobuf:"bytes,2,opt,name=wait_token,json=waitToken" json:"wait_token,omitempty"` // If set to `true`, returns `google.rpc.Code.OK` status and sets the // `wait_expired` response field to `true` when the server-selected timeout // has expired (recommended). // // If set to `false`, returns `google.rpc.Code.ABORTED` status when the // server-selected timeout has expired (deprecated). SuccessOnTimeout bool `protobuf:"varint,3,opt,name=success_on_timeout,json=successOnTimeout" json:"success_on_timeout,omitempty"` }
func (*ListActiveBreakpointsRequest) Descriptor ¶
func (*ListActiveBreakpointsRequest) Descriptor() ([]byte, []int)
func (*ListActiveBreakpointsRequest) GetDebuggeeId ¶
func (m *ListActiveBreakpointsRequest) GetDebuggeeId() string
func (*ListActiveBreakpointsRequest) GetSuccessOnTimeout ¶
func (m *ListActiveBreakpointsRequest) GetSuccessOnTimeout() bool
func (*ListActiveBreakpointsRequest) GetWaitToken ¶
func (m *ListActiveBreakpointsRequest) GetWaitToken() string
func (*ListActiveBreakpointsRequest) ProtoMessage ¶
func (*ListActiveBreakpointsRequest) ProtoMessage()
func (*ListActiveBreakpointsRequest) Reset ¶
func (m *ListActiveBreakpointsRequest) Reset()
func (*ListActiveBreakpointsRequest) String ¶
func (m *ListActiveBreakpointsRequest) String() string
type ListActiveBreakpointsResponse ¶
Response for listing active breakpoints.
type ListActiveBreakpointsResponse struct { // List of all active breakpoints. // The fields `id` and `location` are guaranteed to be set on each breakpoint. Breakpoints []*Breakpoint `protobuf:"bytes,1,rep,name=breakpoints" json:"breakpoints,omitempty"` // A wait token that can be used in the next method call to block until // the list of breakpoints changes. NextWaitToken string `protobuf:"bytes,2,opt,name=next_wait_token,json=nextWaitToken" json:"next_wait_token,omitempty"` // The `wait_expired` field is set to true by the server when the // request times out and the field `success_on_timeout` is set to true. WaitExpired bool `protobuf:"varint,3,opt,name=wait_expired,json=waitExpired" json:"wait_expired,omitempty"` }
func (*ListActiveBreakpointsResponse) Descriptor ¶
func (*ListActiveBreakpointsResponse) Descriptor() ([]byte, []int)
func (*ListActiveBreakpointsResponse) GetBreakpoints ¶
func (m *ListActiveBreakpointsResponse) GetBreakpoints() []*Breakpoint
func (*ListActiveBreakpointsResponse) GetNextWaitToken ¶
func (m *ListActiveBreakpointsResponse) GetNextWaitToken() string
func (*ListActiveBreakpointsResponse) GetWaitExpired ¶
func (m *ListActiveBreakpointsResponse) GetWaitExpired() bool
func (*ListActiveBreakpointsResponse) ProtoMessage ¶
func (*ListActiveBreakpointsResponse) ProtoMessage()
func (*ListActiveBreakpointsResponse) Reset ¶
func (m *ListActiveBreakpointsResponse) Reset()
func (*ListActiveBreakpointsResponse) String ¶
func (m *ListActiveBreakpointsResponse) String() string
type ListBreakpointsRequest ¶
Request to list breakpoints.
type ListBreakpointsRequest struct { // ID of the debuggee whose breakpoints to list. DebuggeeId string `protobuf:"bytes,1,opt,name=debuggee_id,json=debuggeeId" json:"debuggee_id,omitempty"` // When set to `true`, the response includes the list of breakpoints set by // any user. Otherwise, it includes only breakpoints set by the caller. IncludeAllUsers bool `protobuf:"varint,2,opt,name=include_all_users,json=includeAllUsers" json:"include_all_users,omitempty"` // When set to `true`, the response includes active and inactive // breakpoints. Otherwise, it includes only active breakpoints. IncludeInactive bool `protobuf:"varint,3,opt,name=include_inactive,json=includeInactive" json:"include_inactive,omitempty"` // When set, the response includes only breakpoints with the specified action. Action *ListBreakpointsRequest_BreakpointActionValue `protobuf:"bytes,4,opt,name=action" json:"action,omitempty"` // This field is deprecated. The following fields are always stripped out of // the result: `stack_frames`, `evaluated_expressions` and `variable_table`. StripResults bool `protobuf:"varint,5,opt,name=strip_results,json=stripResults" json:"strip_results,omitempty"` // A wait token that, if specified, blocks the call until the breakpoints // list has changed, or a server selected timeout has expired. The value // should be set from the last response. The error code // `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which // should be called again with the same `wait_token`. WaitToken string `protobuf:"bytes,6,opt,name=wait_token,json=waitToken" json:"wait_token,omitempty"` // The client version making the call. // Following: `domain/type/version` (e.g., `google.com/intellij/v1`). ClientVersion string `protobuf:"bytes,8,opt,name=client_version,json=clientVersion" json:"client_version,omitempty"` }
func (*ListBreakpointsRequest) Descriptor ¶
func (*ListBreakpointsRequest) Descriptor() ([]byte, []int)
func (*ListBreakpointsRequest) GetAction ¶
func (m *ListBreakpointsRequest) GetAction() *ListBreakpointsRequest_BreakpointActionValue
func (*ListBreakpointsRequest) GetClientVersion ¶
func (m *ListBreakpointsRequest) GetClientVersion() string
func (*ListBreakpointsRequest) GetDebuggeeId ¶
func (m *ListBreakpointsRequest) GetDebuggeeId() string
func (*ListBreakpointsRequest) GetIncludeAllUsers ¶
func (m *ListBreakpointsRequest) GetIncludeAllUsers() bool
func (*ListBreakpointsRequest) GetIncludeInactive ¶
func (m *ListBreakpointsRequest) GetIncludeInactive() bool
func (*ListBreakpointsRequest) GetStripResults ¶
func (m *ListBreakpointsRequest) GetStripResults() bool
func (*ListBreakpointsRequest) GetWaitToken ¶
func (m *ListBreakpointsRequest) GetWaitToken() string
func (*ListBreakpointsRequest) ProtoMessage ¶
func (*ListBreakpointsRequest) ProtoMessage()
func (*ListBreakpointsRequest) Reset ¶
func (m *ListBreakpointsRequest) Reset()
func (*ListBreakpointsRequest) String ¶
func (m *ListBreakpointsRequest) String() string
type ListBreakpointsRequest_BreakpointActionValue ¶
Wrapper message for `Breakpoint.Action`. Defines a filter on the action field of breakpoints.
type ListBreakpointsRequest_BreakpointActionValue struct {
// Only breakpoints with the specified action will pass the filter.
Value Breakpoint_Action `protobuf:"varint,1,opt,name=value,enum=google.devtools.clouddebugger.v2.Breakpoint_Action" json:"value,omitempty"`
}
func (*ListBreakpointsRequest_BreakpointActionValue) Descriptor ¶
func (*ListBreakpointsRequest_BreakpointActionValue) Descriptor() ([]byte, []int)
func (*ListBreakpointsRequest_BreakpointActionValue) GetValue ¶
func (m *ListBreakpointsRequest_BreakpointActionValue) GetValue() Breakpoint_Action
func (*ListBreakpointsRequest_BreakpointActionValue) ProtoMessage ¶
func (*ListBreakpointsRequest_BreakpointActionValue) ProtoMessage()
func (*ListBreakpointsRequest_BreakpointActionValue) Reset ¶
func (m *ListBreakpointsRequest_BreakpointActionValue) Reset()
func (*ListBreakpointsRequest_BreakpointActionValue) String ¶
func (m *ListBreakpointsRequest_BreakpointActionValue) String() string
type ListBreakpointsResponse ¶
Response for listing breakpoints.
type ListBreakpointsResponse struct { // List of breakpoints matching the request. // The fields `id` and `location` are guaranteed to be set on each breakpoint. // The fields: `stack_frames`, `evaluated_expressions` and `variable_table` // are cleared on each breakpoint regardless of it's status. Breakpoints []*Breakpoint `protobuf:"bytes,1,rep,name=breakpoints" json:"breakpoints,omitempty"` // A wait token that can be used in the next call to `list` (REST) or // `ListBreakpoints` (RPC) to block until the list of breakpoints has changes. NextWaitToken string `protobuf:"bytes,2,opt,name=next_wait_token,json=nextWaitToken" json:"next_wait_token,omitempty"` }
func (*ListBreakpointsResponse) Descriptor ¶
func (*ListBreakpointsResponse) Descriptor() ([]byte, []int)
func (*ListBreakpointsResponse) GetBreakpoints ¶
func (m *ListBreakpointsResponse) GetBreakpoints() []*Breakpoint
func (*ListBreakpointsResponse) GetNextWaitToken ¶
func (m *ListBreakpointsResponse) GetNextWaitToken() string
func (*ListBreakpointsResponse) ProtoMessage ¶
func (*ListBreakpointsResponse) ProtoMessage()
func (*ListBreakpointsResponse) Reset ¶
func (m *ListBreakpointsResponse) Reset()
func (*ListBreakpointsResponse) String ¶
func (m *ListBreakpointsResponse) String() string
type ListDebuggeesRequest ¶
Request to list debuggees.
type ListDebuggeesRequest struct { // Project number of a Google Cloud project whose debuggees to list. Project string `protobuf:"bytes,2,opt,name=project" json:"project,omitempty"` // When set to `true`, the result includes all debuggees. Otherwise, the // result includes only debuggees that are active. IncludeInactive bool `protobuf:"varint,3,opt,name=include_inactive,json=includeInactive" json:"include_inactive,omitempty"` // The client version making the call. // Following: `domain/type/version` (e.g., `google.com/intellij/v1`). ClientVersion string `protobuf:"bytes,4,opt,name=client_version,json=clientVersion" json:"client_version,omitempty"` }
func (*ListDebuggeesRequest) Descriptor ¶
func (*ListDebuggeesRequest) Descriptor() ([]byte, []int)
func (*ListDebuggeesRequest) GetClientVersion ¶
func (m *ListDebuggeesRequest) GetClientVersion() string
func (*ListDebuggeesRequest) GetIncludeInactive ¶
func (m *ListDebuggeesRequest) GetIncludeInactive() bool
func (*ListDebuggeesRequest) GetProject ¶
func (m *ListDebuggeesRequest) GetProject() string
func (*ListDebuggeesRequest) ProtoMessage ¶
func (*ListDebuggeesRequest) ProtoMessage()
func (*ListDebuggeesRequest) Reset ¶
func (m *ListDebuggeesRequest) Reset()
func (*ListDebuggeesRequest) String ¶
func (m *ListDebuggeesRequest) String() string
type ListDebuggeesResponse ¶
Response for listing debuggees.
type ListDebuggeesResponse struct { // List of debuggees accessible to the calling user. // Note that the `description` field is the only human readable field // that should be displayed to the user. // The fields `debuggee.id` and `description` fields are guaranteed to be // set on each debuggee. Debuggees []*Debuggee `protobuf:"bytes,1,rep,name=debuggees" json:"debuggees,omitempty"` }
func (*ListDebuggeesResponse) Descriptor ¶
func (*ListDebuggeesResponse) Descriptor() ([]byte, []int)
func (*ListDebuggeesResponse) GetDebuggees ¶
func (m *ListDebuggeesResponse) GetDebuggees() []*Debuggee
func (*ListDebuggeesResponse) ProtoMessage ¶
func (*ListDebuggeesResponse) ProtoMessage()
func (*ListDebuggeesResponse) Reset ¶
func (m *ListDebuggeesResponse) Reset()
func (*ListDebuggeesResponse) String ¶
func (m *ListDebuggeesResponse) String() string
type RegisterDebuggeeRequest ¶
Request to register a debuggee.
type RegisterDebuggeeRequest struct { // Debuggee information to register. // The fields `project`, `uniquifier`, `description` and `agent_version` // of the debuggee must be set. Debuggee *Debuggee `protobuf:"bytes,1,opt,name=debuggee" json:"debuggee,omitempty"` }
func (*RegisterDebuggeeRequest) Descriptor ¶
func (*RegisterDebuggeeRequest) Descriptor() ([]byte, []int)
func (*RegisterDebuggeeRequest) GetDebuggee ¶
func (m *RegisterDebuggeeRequest) GetDebuggee() *Debuggee
func (*RegisterDebuggeeRequest) ProtoMessage ¶
func (*RegisterDebuggeeRequest) ProtoMessage()
func (*RegisterDebuggeeRequest) Reset ¶
func (m *RegisterDebuggeeRequest) Reset()
func (*RegisterDebuggeeRequest) String ¶
func (m *RegisterDebuggeeRequest) String() string
type RegisterDebuggeeResponse ¶
Response for registering a debuggee.
type RegisterDebuggeeResponse struct { // Debuggee resource. // The field `id` is guranteed to be set (in addition to the echoed fields). Debuggee *Debuggee `protobuf:"bytes,1,opt,name=debuggee" json:"debuggee,omitempty"` }
func (*RegisterDebuggeeResponse) Descriptor ¶
func (*RegisterDebuggeeResponse) Descriptor() ([]byte, []int)
func (*RegisterDebuggeeResponse) GetDebuggee ¶
func (m *RegisterDebuggeeResponse) GetDebuggee() *Debuggee
func (*RegisterDebuggeeResponse) ProtoMessage ¶
func (*RegisterDebuggeeResponse) ProtoMessage()
func (*RegisterDebuggeeResponse) Reset ¶
func (m *RegisterDebuggeeResponse) Reset()
func (*RegisterDebuggeeResponse) String ¶
func (m *RegisterDebuggeeResponse) String() string
type SetBreakpointRequest ¶
Request to set a breakpoint
type SetBreakpointRequest struct { // ID of the debuggee where the breakpoint is to be set. DebuggeeId string `protobuf:"bytes,1,opt,name=debuggee_id,json=debuggeeId" json:"debuggee_id,omitempty"` // Breakpoint specification to set. // The field 'location' of the breakpoint must be set. Breakpoint *Breakpoint `protobuf:"bytes,2,opt,name=breakpoint" json:"breakpoint,omitempty"` // The client version making the call. // Following: `domain/type/version` (e.g., `google.com/intellij/v1`). ClientVersion string `protobuf:"bytes,4,opt,name=client_version,json=clientVersion" json:"client_version,omitempty"` }
func (*SetBreakpointRequest) Descriptor ¶
func (*SetBreakpointRequest) Descriptor() ([]byte, []int)
func (*SetBreakpointRequest) GetBreakpoint ¶
func (m *SetBreakpointRequest) GetBreakpoint() *Breakpoint
func (*SetBreakpointRequest) GetClientVersion ¶
func (m *SetBreakpointRequest) GetClientVersion() string
func (*SetBreakpointRequest) GetDebuggeeId ¶
func (m *SetBreakpointRequest) GetDebuggeeId() string
func (*SetBreakpointRequest) ProtoMessage ¶
func (*SetBreakpointRequest) ProtoMessage()
func (*SetBreakpointRequest) Reset ¶
func (m *SetBreakpointRequest) Reset()
func (*SetBreakpointRequest) String ¶
func (m *SetBreakpointRequest) String() string
type SetBreakpointResponse ¶
Response for setting a breakpoint.
type SetBreakpointResponse struct { // Breakpoint resource. // The field `id` is guaranteed to be set (in addition to the echoed fileds). Breakpoint *Breakpoint `protobuf:"bytes,1,opt,name=breakpoint" json:"breakpoint,omitempty"` }
func (*SetBreakpointResponse) Descriptor ¶
func (*SetBreakpointResponse) Descriptor() ([]byte, []int)
func (*SetBreakpointResponse) GetBreakpoint ¶
func (m *SetBreakpointResponse) GetBreakpoint() *Breakpoint
func (*SetBreakpointResponse) ProtoMessage ¶
func (*SetBreakpointResponse) ProtoMessage()
func (*SetBreakpointResponse) Reset ¶
func (m *SetBreakpointResponse) Reset()
func (*SetBreakpointResponse) String ¶
func (m *SetBreakpointResponse) String() string
type SourceLocation ¶
Represents a location in the source code.
type SourceLocation struct { // Path to the source file within the source context of the target binary. Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"` // Line inside the file. The first line in the file has the value `1`. Line int32 `protobuf:"varint,2,opt,name=line" json:"line,omitempty"` }
func (*SourceLocation) Descriptor ¶
func (*SourceLocation) Descriptor() ([]byte, []int)
func (*SourceLocation) GetLine ¶
func (m *SourceLocation) GetLine() int32
func (*SourceLocation) GetPath ¶
func (m *SourceLocation) GetPath() string
func (*SourceLocation) ProtoMessage ¶
func (*SourceLocation) ProtoMessage()
func (*SourceLocation) Reset ¶
func (m *SourceLocation) Reset()
func (*SourceLocation) String ¶
func (m *SourceLocation) String() string
type StackFrame ¶
Represents a stack frame context.
type StackFrame struct { // Demangled function name at the call site. Function string `protobuf:"bytes,1,opt,name=function" json:"function,omitempty"` // Source location of the call site. Location *SourceLocation `protobuf:"bytes,2,opt,name=location" json:"location,omitempty"` // Set of arguments passed to this function. // Note that this might not be populated for all stack frames. Arguments []*Variable `protobuf:"bytes,3,rep,name=arguments" json:"arguments,omitempty"` // Set of local variables at the stack frame location. // Note that this might not be populated for all stack frames. Locals []*Variable `protobuf:"bytes,4,rep,name=locals" json:"locals,omitempty"` }
func (*StackFrame) Descriptor ¶
func (*StackFrame) Descriptor() ([]byte, []int)
func (*StackFrame) GetArguments ¶
func (m *StackFrame) GetArguments() []*Variable
func (*StackFrame) GetFunction ¶
func (m *StackFrame) GetFunction() string
func (*StackFrame) GetLocals ¶
func (m *StackFrame) GetLocals() []*Variable
func (*StackFrame) GetLocation ¶
func (m *StackFrame) GetLocation() *SourceLocation
func (*StackFrame) ProtoMessage ¶
func (*StackFrame) ProtoMessage()
func (*StackFrame) Reset ¶
func (m *StackFrame) Reset()
func (*StackFrame) String ¶
func (m *StackFrame) String() string
type StatusMessage ¶
Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
type StatusMessage struct { // Distinguishes errors from informational messages. IsError bool `protobuf:"varint,1,opt,name=is_error,json=isError" json:"is_error,omitempty"` // Reference to which the message applies. RefersTo StatusMessage_Reference `protobuf:"varint,2,opt,name=refers_to,json=refersTo,enum=google.devtools.clouddebugger.v2.StatusMessage_Reference" json:"refers_to,omitempty"` // Status message text. Description *FormatMessage `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"` }
func (*StatusMessage) Descriptor ¶
func (*StatusMessage) Descriptor() ([]byte, []int)
func (*StatusMessage) GetDescription ¶
func (m *StatusMessage) GetDescription() *FormatMessage
func (*StatusMessage) GetIsError ¶
func (m *StatusMessage) GetIsError() bool
func (*StatusMessage) GetRefersTo ¶
func (m *StatusMessage) GetRefersTo() StatusMessage_Reference
func (*StatusMessage) ProtoMessage ¶
func (*StatusMessage) ProtoMessage()
func (*StatusMessage) Reset ¶
func (m *StatusMessage) Reset()
func (*StatusMessage) String ¶
func (m *StatusMessage) String() string
type StatusMessage_Reference ¶
Enumerates references to which the message applies.
type StatusMessage_Reference int32
const ( // Status doesn't refer to any particular input. StatusMessage_UNSPECIFIED StatusMessage_Reference = 0 // Status applies to the breakpoint and is related to its location. StatusMessage_BREAKPOINT_SOURCE_LOCATION StatusMessage_Reference = 3 // Status applies to the breakpoint and is related to its condition. StatusMessage_BREAKPOINT_CONDITION StatusMessage_Reference = 4 // Status applies to the breakpoint and is related to its expressions. StatusMessage_BREAKPOINT_EXPRESSION StatusMessage_Reference = 7 // Status applies to the breakpoint and is related to its age. StatusMessage_BREAKPOINT_AGE StatusMessage_Reference = 8 // Status applies to the entire variable. StatusMessage_VARIABLE_NAME StatusMessage_Reference = 5 // Status applies to variable value (variable name is valid). StatusMessage_VARIABLE_VALUE StatusMessage_Reference = 6 )
func (StatusMessage_Reference) EnumDescriptor ¶
func (StatusMessage_Reference) EnumDescriptor() ([]byte, []int)
func (StatusMessage_Reference) String ¶
func (x StatusMessage_Reference) String() string
type UpdateActiveBreakpointRequest ¶
Request to update an active breakpoint.
type UpdateActiveBreakpointRequest struct { // Identifies the debuggee being debugged. DebuggeeId string `protobuf:"bytes,1,opt,name=debuggee_id,json=debuggeeId" json:"debuggee_id,omitempty"` // Updated breakpoint information. // The field 'id' must be set. Breakpoint *Breakpoint `protobuf:"bytes,2,opt,name=breakpoint" json:"breakpoint,omitempty"` }
func (*UpdateActiveBreakpointRequest) Descriptor ¶
func (*UpdateActiveBreakpointRequest) Descriptor() ([]byte, []int)
func (*UpdateActiveBreakpointRequest) GetBreakpoint ¶
func (m *UpdateActiveBreakpointRequest) GetBreakpoint() *Breakpoint
func (*UpdateActiveBreakpointRequest) GetDebuggeeId ¶
func (m *UpdateActiveBreakpointRequest) GetDebuggeeId() string
func (*UpdateActiveBreakpointRequest) ProtoMessage ¶
func (*UpdateActiveBreakpointRequest) ProtoMessage()
func (*UpdateActiveBreakpointRequest) Reset ¶
func (m *UpdateActiveBreakpointRequest) Reset()
func (*UpdateActiveBreakpointRequest) String ¶
func (m *UpdateActiveBreakpointRequest) String() string
type UpdateActiveBreakpointResponse ¶
Response for updating an active breakpoint. The message is defined to allow future extensions.
type UpdateActiveBreakpointResponse struct { }
func (*UpdateActiveBreakpointResponse) Descriptor ¶
func (*UpdateActiveBreakpointResponse) Descriptor() ([]byte, []int)
func (*UpdateActiveBreakpointResponse) ProtoMessage ¶
func (*UpdateActiveBreakpointResponse) ProtoMessage()
func (*UpdateActiveBreakpointResponse) Reset ¶
func (m *UpdateActiveBreakpointResponse) Reset()
func (*UpdateActiveBreakpointResponse) String ¶
func (m *UpdateActiveBreakpointResponse) String() string
type Variable ¶
Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented:
1) A simple variable:
int x = 5 { name: "x", value: "5", type: "int" } // Captured variable
2) A compound object:
struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } }
3) A pointer where the pointee was captured:
T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } }
4) A pointer where the pointee was not captured:
T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } }
The status should describe the reason for the missing value, such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
Note that a null pointer should not have members.
5) An unnamed value:
int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } }
6) An unnamed pointer where the pointee was not captured:
int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } }
To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable.
When using the shared variable table, the following variables:
T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } }
Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references.
The type field is optional. The debugger agent may or may not support it.
type Variable struct { // Name of the variable, if any. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // Simple value of the variable. Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"` // Variable type (e.g. `MyClass`). If the variable is split with // `var_table_index`, `type` goes next to `value`. The interpretation of // a type is agent specific. It is recommended to include the dynamic type // rather than a static type of an object. Type string `protobuf:"bytes,6,opt,name=type" json:"type,omitempty"` // Members contained or pointed to by the variable. Members []*Variable `protobuf:"bytes,3,rep,name=members" json:"members,omitempty"` // Reference to a variable in the shared variable table. More than // one variable can reference the same variable in the table. The // `var_table_index` field is an index into `variable_table` in Breakpoint. VarTableIndex *google_protobuf2.Int32Value `protobuf:"bytes,4,opt,name=var_table_index,json=varTableIndex" json:"var_table_index,omitempty"` // Status associated with the variable. This field will usually stay // unset. A status of a single variable only applies to that variable or // expression. The rest of breakpoint data still remains valid. Variables // might be reported in error state even when breakpoint is not in final // state. // // The message may refer to variable name with `refers_to` set to // `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. // In either case variable value and members will be unset. // // Example of error message applied to name: `Invalid expression syntax`. // // Example of information message applied to value: `Not captured`. // // Examples of error message applied to value: // // * `Malformed string`, // * `Field f not found in class C` // * `Null pointer dereference` Status *StatusMessage `protobuf:"bytes,5,opt,name=status" json:"status,omitempty"` }
func (*Variable) Descriptor ¶
func (*Variable) Descriptor() ([]byte, []int)
func (*Variable) GetMembers ¶
func (m *Variable) GetMembers() []*Variable
func (*Variable) GetName ¶
func (m *Variable) GetName() string
func (*Variable) GetStatus ¶
func (m *Variable) GetStatus() *StatusMessage
func (*Variable) GetType ¶
func (m *Variable) GetType() string
func (*Variable) GetValue ¶
func (m *Variable) GetValue() string
func (*Variable) GetVarTableIndex ¶
func (m *Variable) GetVarTableIndex() *google_protobuf2.Int32Value
func (*Variable) ProtoMessage ¶
func (*Variable) ProtoMessage()
func (*Variable) Reset ¶
func (m *Variable) Reset()
func (*Variable) String ¶
func (m *Variable) String() string