folly::TestLogHandler Class Reference

#include <TestLogHandler.h>

Inheritance diagram for folly::TestLogHandler:

Public Types
using	Options = LogHandlerConfig::Options

Public Member Functions
	TestLogHandler ()
	TestLogHandler (LogHandlerConfig config)
std::vector< std::pair< LogMessage, const LogCategory * > > &	getMessages ()
std::vector< std::string >	getMessageValues () const
void	clearMessages ()
void	handleMessage (const LogMessage &message, const LogCategory *handlerCategory) override
void	flush () override
uint64_t	getFlushCount () const
LogHandlerConfig	getConfig () const override
void	setOptions (const Options &options)
Public Member Functions inherited from folly::LogHandler
virtual	~LogHandler ()=default

Protected Attributes
std::vector< std::pair< LogMessage, const LogCategory * > >	messages_
uint64_t	flushCount_ {0}
std::map< std::string, std::string >	options_
LogHandlerConfig	config_

Detailed Description

A LogHandler that simply keeps a vector of all LogMessages it receives.

This class is not thread-safe. It is intended to be used in single-threaded tests.

Definition at line 36 of file TestLogHandler.h.

Member Typedef Documentation

using folly::TestLogHandler::Options = LogHandlerConfig::Options

Definition at line 38 of file TestLogHandler.h.

Constructor & Destructor Documentation

folly::TestLogHandler::TestLogHandler ( )

inline

Definition at line 40 of file TestLogHandler.h.

: config_{"test"} {}

folly::TestLogHandler::TestLogHandler ( LogHandlerConfig  config )

inlineexplicit

Definition at line 41 of file TestLogHandler.h.

References folly::gen::move.

      : config_{std::move(config)} {}

Member Function Documentation

void folly::TestLogHandler::clearMessages ( )

inline

Definition at line 49 of file TestLogHandler.h.

References messages_.

                       {
    messages_.clear();
  }

void folly::TestLogHandler::flush ( )

inlineoverridevirtual

Block until all messages that have already been sent to this LogHandler have been processed.

For LogHandlers that perform asynchronous processing of log messages, this ensures that messages already sent to this handler have finished being processed.

Other threads may still call handleMessage() while flush() is running. handleMessage() calls that did not complete before the flush() call started will not necessarily be processed by the flush call.

Implements folly::LogHandler.

Definition at line 59 of file TestLogHandler.h.

References flushCount_.

                        {
    ++flushCount_;
  }

LogHandlerConfig folly::TestLogHandler::getConfig ( ) const

inlineoverridevirtual

Return a LogHandlerConfig object describing the configuration of this LogHandler.

Implements folly::LogHandler.

Definition at line 67 of file TestLogHandler.h.

References config_.

                                              {
    return config_;
  }

uint64_t folly::TestLogHandler::getFlushCount ( ) const

inline

Definition at line 63 of file TestLogHandler.h.

References flushCount_.

                                 {
    return flushCount_;
  }

std::vector<std::pair<LogMessage, const LogCategory*> >& folly::TestLogHandler::getMessages ( )

inline

Definition at line 44 of file TestLogHandler.h.

References getMessageValues(), and messages_.

                                                                    {
    return messages_;
  }

std::vector< std::string > folly::TestLogHandler::getMessageValues

(

)

const

Definition at line 22 of file TestLogHandler.cpp.

References messages_, and values().

Referenced by getMessages().

                                                            {
  std::vector<std::string> values;
  values.reserve(messages_.size());
  for (const auto& msgInfo : messages_) {
    values.push_back(msgInfo.first.getMessage());
  }
  return values;
}

void folly::TestLogHandler::handleMessage ( const LogMessage &  message, const LogCategory *  handlerCategory  )

inlineoverridevirtual

handleMessage() is called when a log message is processed by a LogCategory that this handler is attached to.

This must be implemented by LogHandler subclasses.

handleMessage() will always be invoked from the thread that logged the message. LogMessage::getThreadID() contains the thread ID, but the LogHandler can also include any other thread-local state they desire, and this will always be data for the thread that originated the log message.

Parameters

message	The LogMessage objet.
handlerCategory	The LogCategory that invoked handleMessage(). This is the category that this LogHandler is attached to. Note that this may be different than the category that this message was originally logged at. message->getCategory() returns the category of the log message.

Implements folly::LogHandler.

Definition at line 53 of file TestLogHandler.h.

References messages_.

                                                   {
    messages_.emplace_back(message, handlerCategory);
  }

void folly::TestLogHandler::setOptions ( const Options &  options )

inline

Definition at line 71 of file TestLogHandler.h.

References config_, and folly::LogHandlerConfig::options.

                                          {
    config_.options = options;
  }

Member Data Documentation

LogHandlerConfig folly::TestLogHandler::config_

protected

Definition at line 79 of file TestLogHandler.h.

Referenced by getConfig(), and setOptions().

uint64_t folly::TestLogHandler::flushCount_ {0}

protected

Definition at line 77 of file TestLogHandler.h.

Referenced by flush(), and getFlushCount().

std::vector<std::pair<LogMessage, const LogCategory*> > folly::TestLogHandler::messages_

protected

Definition at line 76 of file TestLogHandler.h.

Referenced by clearMessages(), getMessages(), getMessageValues(), and handleMessage().

std::map<std::string, std::string> folly::TestLogHandler::options_

protected

Definition at line 78 of file TestLogHandler.h.

---

The documentation for this class was generated from the following files:

• proxygen/folly/folly/logging/test/TestLogHandler.h
• proxygen/folly/folly/logging/test/TestLogHandler.cpp