Skip to content

Commit a983fe9

Browse files
committed
Added deprecation warning for gRPC MonitorService
1 parent 4256524 commit a983fe9

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

rpc/cc/arduino/cli/monitor/v1/monitor.pb.go

+9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/cc/arduino/cli/monitor/v1/monitor.proto

+13-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ option go_package = "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/monitor/v
2121

2222
import "google/protobuf/struct.proto";
2323

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

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

85+
// DEPRECATION WARNING: StreamingOpenResponse is deprecated and will be removed
86+
// in a future release. Use CommandService.Monitor and
87+
// CommandService.EnumerateMonitorPortSettings instead.
7688
message StreamingOpenResponse {
7789
// The data received from the target.
7890
bytes data = 1;

0 commit comments

Comments
 (0)