log_sink_registry.h

Enable keyboard shortcuts

// Copyright 2022 The Abseil Authors.

//

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

//

//      https://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

//

// -----------------------------------------------------------------------------

// File: log/log_sink_registry.h

// -----------------------------------------------------------------------------

//

// This header declares APIs to operate on global set of registered log sinks.

#ifndef ABSL_LOG_LOG_SINK_REGISTRY_H_

#define ABSL_LOG_LOG_SINK_REGISTRY_H_

#include "absl/base/config.h"

#include "absl/log/internal/log_sink_set.h"

#include "absl/log/log_sink.h"

namespace absl {

ABSL_NAMESPACE_BEGIN

// AddLogSink(), RemoveLogSink()

//

// Adds or removes a `absl::LogSink` as a consumer of logging data.

//

// These functions are thread-safe.

//

// It is an error to attempt to add a sink that's already registered or to

// attempt to remove one that isn't.

//

// To avoid unbounded recursion, dispatch to registered `absl::LogSink`s is

// disabled per-thread while running the `Send()` method of registered

// `absl::LogSink`s.  Affected messages are dispatched to a special internal

// sink instead which writes them to `stderr`.

//

// Do not call these inside `absl::LogSink::Send`.

inline void AddLogSink(absl::LogSink* sink) { log_internal::AddLogSink(sink); }

inline void RemoveLogSink(absl::LogSink* sink) {

  log_internal::RemoveLogSink(sink);

// FlushLogSinks()

//

// Calls `absl::LogSink::Flush` on all registered sinks.

//

// Do not call this inside `absl::LogSink::Send`.

inline void FlushLogSinks() { log_internal::FlushLogSinks(); }

ABSL_NAMESPACE_END

}  // namespace absl

#endif  // ABSL_LOG_LOG_SINK_REGISTRY_H_