folly/experimental/logging/LogHandlerConfig.h

   1 /*
   2  * Copyright 2004-present Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #pragma once
  17
  18 #include <string>
  19 #include <unordered_map>
  20
  21 #include <folly/Optional.h>
  22 #include <folly/Range.h>
  23
  24 namespace folly {
  25
  26 /**
  27  * Configuration for a LogHandler
  28  */
  29 class LogHandlerConfig {
  30  public:
  31   using Options = std::unordered_map<std::string, std::string>;
  32
  33   LogHandlerConfig();
  34   explicit LogHandlerConfig(StringPiece type);
  35   explicit LogHandlerConfig(Optional<StringPiece> type);
  36   LogHandlerConfig(StringPiece type, Options options);
  37   LogHandlerConfig(Optional<StringPiece> type, Options options);
  38
  39   /**
  40    * Update this LogHandlerConfig object by merging in settings from another
  41    * LogConfig.
  42    *
  43    * The other LogHandlerConfig must not have a type set.
  44    */
  45   void update(const LogHandlerConfig& other);
  46
  47   bool operator==(const LogHandlerConfig& other) const;
  48   bool operator!=(const LogHandlerConfig& other) const;
  49
  50   /**
  51    * The handler type name.
  52    *
  53    * If this field is unset than this configuration object is intended to be
  54    * used to update an existing LogHandler object.  This field must always
  55    * be set in the configuration for all existing LogHandler objects.
  56    */
  57   Optional<std::string> type;
  58
  59   Options options;
  60 };
  61
  62 } // namespace folly