xref: /aosp_15_r20/external/pigweed/pw_log_rpc/public/pw_log_rpc/log_service.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2021 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 //     https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 
15 #pragma once
16 
17 #include "pw_log/proto/log.raw_rpc.pb.h"
18 #include "pw_log_rpc/rpc_log_drain_map.h"
19 #include "pw_status/status.h"
20 
21 namespace pw::log_rpc {
22 
23 // The RPC LogService provides a way to start a log stream on a known RPC
24 // channel with a writer provided on a call. Log streams maintenance is flexible
25 // and delegated outside the service.
26 class LogService final : public log::pw_rpc::raw::Logs::Service<LogService> {
27  public:
LogService(RpcLogDrainMap & drains)28   LogService(RpcLogDrainMap& drains) : drains_(drains) {}
29 
30   // Starts listening to logs on the given RPC channel and writer. The call is
31   // ignored if the channel was not pre-registered in the drain map. If there is
32   // an existent stream of logs for the given channel and previous writer, the
33   // writer in this call is closed without finishing the RPC call and the log
34   // stream using the previous writer continues.
35   void Listen(ConstByteSpan, rpc::RawServerWriter& writer);
36 
37  private:
38   RpcLogDrainMap& drains_;
39 };
40 
41 }  // namespace pw::log_rpc
42