folly/experimental/logging/LogFormatter.h

   1 /*
   2  * Copyright 2017-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
  20 namespace folly {
  21
  22 class LogCategory;
  23 class LogMessage;
  24
  25 /**
  26  * LogFormatter defines the interface for serializing a LogMessage object
  27  * into a buffer to be given to a LogWriter.
  28  */
  29 class LogFormatter {
  30  public:
  31   virtual ~LogFormatter() {}
  32
  33   /**
  34    * Serialze a LogMessage object.
  35    *
  36    * @param message The LogMessage object to serialze.
  37    * @param handlerCategory The LogCategory that is currently handling this
  38    *     message.  Note that this is likely different from the LogCategory
  39    *     where the message was originally logged, which can be accessed as
  40    *     message->getCategory()
  41    */
  42   virtual std::string formatMessage(
  43       const LogMessage& message,
  44       const LogCategory* handlerCategory) = 0;
  45 };
  46 } // namespace folly