third_party/pigweed/repo/pw_log_multisink/public/pw_log_multisink/sink.h

   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 #pragma once
  15
  16 #include "pw_containers/intrusive_list.h"
  17
  18 namespace pw::log_sink {
  19
  20 class Sink : public IntrusiveList<Sink>::Item {
  21  public:
  22   // Provides an entry to the sink (e.g. an encoded protobuf).
  23   virtual void HandleEntry(ConstByteSpan entry) = 0;
  24   // Informs the sink of an entry that was dropped. This is used to indicate
  25   // to the sink that it will produce gaps in outgoing entries.
  26   virtual void HandleDropped(size_t count = 1) = 0;
  27
  28   virtual ~Sink() = default;
  29 };
  30
  31 }  // namespace pw::log_sink