debug

package
v0.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 15, 2023 License: GPL-3.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DebugService_Debug_FullMethodName          = "/cc.arduino.cli.debug.v1.DebugService/Debug"
	DebugService_GetDebugConfig_FullMethodName = "/cc.arduino.cli.debug.v1.DebugService/GetDebugConfig"
)

Variables

View Source 
var DebugService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cc.arduino.cli.debug.v1.DebugService",
	HandlerType: (*DebugServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetDebugConfig",
			Handler:    _DebugService_GetDebugConfig_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Debug",
			Handler:       _DebugService_Debug_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "cc/arduino/cli/debug/v1/debug.proto",
}

DebugService_ServiceDesc is the grpc.ServiceDesc for DebugService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_cc_arduino_cli_debug_v1_debug_proto protoreflect.FileDescriptor

Functions

func RegisterDebugServiceServer 

func RegisterDebugServiceServer(s grpc.ServiceRegistrar, srv DebugServiceServer)

Types

type DebugConfigRequest 

type DebugConfigRequest struct {

	// Arduino Core Service instance from the `Init` response.
	Instance *v1.Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
	// Fully qualified board name of the board in use
	// (e.g., `arduino:samd:mkr1000`). If this is omitted, the FQBN attached to
	// the sketch will be used.
	Fqbn string `protobuf:"bytes,2,opt,name=fqbn,proto3" json:"fqbn,omitempty"`
	// Path to the sketch that is running on the board. The compiled executable
	// is expected to be located under this path.
	SketchPath string `protobuf:"bytes,3,opt,name=sketch_path,json=sketchPath,proto3" json:"sketch_path,omitempty"`
	// Port of the debugger (optional).
	Port *v1.Port `protobuf:"bytes,4,opt,name=port,proto3" json:"port,omitempty"`
	// Which GDB command interpreter to use.
	Interpreter string `protobuf:"bytes,5,opt,name=interpreter,proto3" json:"interpreter,omitempty"`
	// Directory containing the compiled executable. If `import_dir` is not
	// specified, the executable is assumed to be in
	// `{sketch_path}/build/{fqbn}/`.
	ImportDir string `protobuf:"bytes,8,opt,name=import_dir,json=importDir,proto3" json:"import_dir,omitempty"`
	// The programmer to use for debugging.
	Programmer string `protobuf:"bytes,9,opt,name=programmer,proto3" json:"programmer,omitempty"`
	// contains filtered or unexported fields
}

func (*DebugConfigRequest) Descriptor deprecated 

func (*DebugConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use DebugConfigRequest.ProtoReflect.Descriptor instead.

func (*DebugConfigRequest) GetFqbn 

func (x *DebugConfigRequest) GetFqbn() string

func (*DebugConfigRequest) GetImportDir 

func (x *DebugConfigRequest) GetImportDir() string

func (*DebugConfigRequest) GetInstance 

func (x *DebugConfigRequest) GetInstance() *v1.Instance

func (*DebugConfigRequest) GetInterpreter 

func (x *DebugConfigRequest) GetInterpreter() string

func (*DebugConfigRequest) GetPort 

func (x *DebugConfigRequest) GetPort() *v1.Port

func (*DebugConfigRequest) GetProgrammer 

func (x *DebugConfigRequest) GetProgrammer() string

func (*DebugConfigRequest) GetSketchPath 

func (x *DebugConfigRequest) GetSketchPath() string

func (*DebugConfigRequest) ProtoMessage 

func (*DebugConfigRequest) ProtoMessage()

func (*DebugConfigRequest) ProtoReflect 

func (x *DebugConfigRequest) ProtoReflect() protoreflect.Message

func (*DebugConfigRequest) Reset 

func (x *DebugConfigRequest) Reset()

func (*DebugConfigRequest) String 

func (x *DebugConfigRequest) String() string

type DebugRequest 

type DebugRequest struct {

	// Provides information to the debug that specifies which is the target.
	// The first `StreamingOpenReq` message must contain a `DebugReq`
	// message.
	DebugRequest *DebugConfigRequest `protobuf:"bytes,1,opt,name=debug_request,json=debugRequest,proto3" json:"debug_request,omitempty"`
	// The data to be sent to the target being monitored.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// Set this to true to send and Interrupt signal to the debugger process
	SendInterrupt bool `protobuf:"varint,3,opt,name=send_interrupt,json=sendInterrupt,proto3" json:"send_interrupt,omitempty"`
	// contains filtered or unexported fields
}

The top-level message sent by the client for the `Debug` method. Multiple `DebugReq` messages can be sent but the first message must contain a `DebugConfigReq` message to initialize the debug session. All subsequent messages must contain bytes to be sent to the debug session and must not contain a `DebugReq` message.

func (*DebugRequest) Descriptor deprecated 

func (*DebugRequest) Descriptor() ([]byte, []int)

Deprecated: Use DebugRequest.ProtoReflect.Descriptor instead.

func (*DebugRequest) GetData 

func (x *DebugRequest) GetData() []byte

func (*DebugRequest) GetDebugRequest 

func (x *DebugRequest) GetDebugRequest() *DebugConfigRequest

func (*DebugRequest) GetSendInterrupt 

func (x *DebugRequest) GetSendInterrupt() bool

func (*DebugRequest) ProtoMessage 

func (*DebugRequest) ProtoMessage()

func (*DebugRequest) ProtoReflect 

func (x *DebugRequest) ProtoReflect() protoreflect.Message

func (*DebugRequest) Reset 

func (x *DebugRequest) Reset()

func (*DebugRequest) String 

func (x *DebugRequest) String() string

type DebugResponse 

type DebugResponse struct {

	// Incoming data from the debugger tool.
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// Incoming error output from the debugger tool.
	Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*DebugResponse) Descriptor deprecated 

func (*DebugResponse) Descriptor() ([]byte, []int)

Deprecated: Use DebugResponse.ProtoReflect.Descriptor instead.

func (*DebugResponse) GetData 

func (x *DebugResponse) GetData() []byte

func (*DebugResponse) GetError 

func (x *DebugResponse) GetError() string

func (*DebugResponse) ProtoMessage 

func (*DebugResponse) ProtoMessage()

func (*DebugResponse) ProtoReflect 

func (x *DebugResponse) ProtoReflect() protoreflect.Message

func (*DebugResponse) Reset 

func (x *DebugResponse) Reset()

func (*DebugResponse) String 

func (x *DebugResponse) String() string

type DebugServiceClient 

type DebugServiceClient interface {
	// Start a debug session and communicate with the debugger tool.
	Debug(ctx context.Context, opts ...grpc.CallOption) (DebugService_DebugClient, error)
	GetDebugConfig(ctx context.Context, in *DebugConfigRequest, opts ...grpc.CallOption) (*GetDebugConfigResponse, error)
}

DebugServiceClient is the client API for DebugService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDebugServiceClient 

func NewDebugServiceClient(cc grpc.ClientConnInterface) DebugServiceClient

type DebugServiceServer 

type DebugServiceServer interface {
	// Start a debug session and communicate with the debugger tool.
	Debug(DebugService_DebugServer) error
	GetDebugConfig(context.Context, *DebugConfigRequest) (*GetDebugConfigResponse, error)
	// contains filtered or unexported methods
}

DebugServiceServer is the server API for DebugService service. All implementations must embed UnimplementedDebugServiceServer for forward compatibility

type DebugService_DebugClient 

type DebugService_DebugClient interface {
	Send(*DebugRequest) error
	Recv() (*DebugResponse, error)
	grpc.ClientStream
}

type DebugService_DebugServer 

type DebugService_DebugServer interface {
	Send(*DebugResponse) error
	Recv() (*DebugRequest, error)
	grpc.ServerStream
}

type GetDebugConfigResponse 

type GetDebugConfigResponse struct {

	// The executable binary to debug
	Executable string `protobuf:"bytes,1,opt,name=executable,proto3" json:"executable,omitempty"`
	// The toolchain type used for the build (for example "gcc")
	Toolchain string `protobuf:"bytes,2,opt,name=toolchain,proto3" json:"toolchain,omitempty"`
	// The toolchain directory
	ToolchainPath string `protobuf:"bytes,3,opt,name=toolchain_path,json=toolchainPath,proto3" json:"toolchain_path,omitempty"`
	// The toolchain architecture prefix (for example "arm-none-eabi-")
	ToolchainPrefix string `protobuf:"bytes,4,opt,name=toolchain_prefix,json=toolchainPrefix,proto3" json:"toolchain_prefix,omitempty"`
	// The GDB server type used to connect to the programmer/board (for example
	// "openocd")
	Server string `protobuf:"bytes,5,opt,name=server,proto3" json:"server,omitempty"`
	// The GDB server directory
	ServerPath string `protobuf:"bytes,6,opt,name=server_path,json=serverPath,proto3" json:"server_path,omitempty"`
	// Extra configuration parameters wrt toolchain
	ToolchainConfiguration map[string]string `` /* 215-byte string literal not displayed */
	// Extra configuration parameters wrt GDB server
	ServerConfiguration map[string]string `` /* 206-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetDebugConfigResponse) Descriptor deprecated 

func (*GetDebugConfigResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetDebugConfigResponse.ProtoReflect.Descriptor instead.

func (*GetDebugConfigResponse) GetExecutable 

func (x *GetDebugConfigResponse) GetExecutable() string

func (*GetDebugConfigResponse) GetServer 

func (x *GetDebugConfigResponse) GetServer() string

func (*GetDebugConfigResponse) GetServerConfiguration 

func (x *GetDebugConfigResponse) GetServerConfiguration() map[string]string

func (*GetDebugConfigResponse) GetServerPath 

func (x *GetDebugConfigResponse) GetServerPath() string

func (*GetDebugConfigResponse) GetToolchain 

func (x *GetDebugConfigResponse) GetToolchain() string

func (*GetDebugConfigResponse) GetToolchainConfiguration 

func (x *GetDebugConfigResponse) GetToolchainConfiguration() map[string]string

func (*GetDebugConfigResponse) GetToolchainPath 

func (x *GetDebugConfigResponse) GetToolchainPath() string

func (*GetDebugConfigResponse) GetToolchainPrefix 

func (x *GetDebugConfigResponse) GetToolchainPrefix() string

func (*GetDebugConfigResponse) ProtoMessage 

func (*GetDebugConfigResponse) ProtoMessage()

func (*GetDebugConfigResponse) ProtoReflect 

func (x *GetDebugConfigResponse) ProtoReflect() protoreflect.Message

func (*GetDebugConfigResponse) Reset 

func (x *GetDebugConfigResponse) Reset()

func (*GetDebugConfigResponse) String 

func (x *GetDebugConfigResponse) String() string

type UnimplementedDebugServiceServer 

type UnimplementedDebugServiceServer struct {
}

UnimplementedDebugServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedDebugServiceServer) Debug 

func (UnimplementedDebugServiceServer) Debug(DebugService_DebugServer) error

func (UnimplementedDebugServiceServer) GetDebugConfig 

func (UnimplementedDebugServiceServer) GetDebugConfig(context.Context, *DebugConfigRequest) (*GetDebugConfigResponse, error)

type UnsafeDebugServiceServer 

type UnsafeDebugServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeDebugServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DebugServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.