Skip to content

Added deprecation warning for gRPC MonitorService #1648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 1, 2022
Merged

Added deprecation warning for gRPC MonitorService #1648

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a983fe9
Added deprecation warning for gRPC MonitorService
cmaglie Feb 1, 2022
04d3a92
Apply suggestions from code review
cmaglie Feb 1, 2022
eea85b9
Added deprecation option
cmaglie Feb 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions rpc/cc/arduino/cli/monitor/v1/monitor.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 13 additions & 1 deletion rpc/cc/arduino/cli/monitor/v1/monitor.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ option go_package = "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/monitor/v

import "google/protobuf/struct.proto";

// MonitorService provides services for boards monitor
// MonitorService provides services for boards monitor.
// DEPRECATION WARNING: MonitorService is deprecated and will be removed in a
// future release. Use CommandService.Monitor and
// CommandService.EnumerateMonitorPortSettings instead.
service MonitorService {
// Open a bidirectional monitor stream. This can be used to implement
// something similar to the Arduino IDE's Serial Monitor.
Expand All @@ -34,6 +37,9 @@ service MonitorService {
// must contain a `monitor_config` message to initialize the monitor target.
// All subsequent messages must contain bytes to be sent to the target
// and must not contain a `monitor_config` message.
// DEPRECATION WARNING: StreaminOpenRequest is deprecated and will be removed in
// a future release. Use CommandService.Monitor and
// CommandService.EnumerateMonitorPortSettings instead.
message StreamingOpenRequest {
// Content must be either a monitor config or data to be sent.
oneof content {
Expand All @@ -53,6 +59,9 @@ message StreamingOpenRequest {

// Tells the monitor which target to open and provides additional parameters
// that might be needed to configure the target or the monitor itself.
// DEPRECATION WARNING: MonitorConfig is deprecated and will be removed
// in a future release. Use CommandService.Monitor and
// CommandService.EnumerateMonitorPortSettings instead.
message MonitorConfig {
enum TargetType {
TARGET_TYPE_SERIAL = 0;
Expand All @@ -73,6 +82,9 @@ message MonitorConfig {
int32 recv_rate_limit_buffer = 4;
}

// DEPRECATION WARNING: StreamingOpenResponse is deprecated and will be removed
// in a future release. Use CommandService.Monitor and
// CommandService.EnumerateMonitorPortSettings instead.
message StreamingOpenResponse {
// The data received from the target.
bytes data = 1;
Expand Down