robot/include/boost/redis/logger.hpp

/* Copyright (c) 2018-2023 Marcelo Zimbres Silva (mzimbres@gmail.com)
 *
 * Distributed under the Boost Software License, Version 1.0. (See
 * accompanying file LICENSE.txt)
 */

#ifndef BOOST_REDIS_LOGGER_HPP
#define BOOST_REDIS_LOGGER_HPP

#include <boost/redis/response.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <string>

namespace boost::system {class error_code;}

namespace boost::redis {

/** @brief Logger class
 *  @ingroup high-level-api
 *
 *  The class can be passed to the connection objects to log to `std::clog`
 *
 *  Notice that currently this class has no stable interface. Users
 *  that don't want any logging can disable it by contructing a logger
 *  with logger::level::emerg to the connection.
 */
class logger {
public:
   /** @brief Syslog-like log levels
    *  @ingroup high-level-api
    */
   enum class level
   {
      /// Disabled
      disabled,

      /// Emergency
      emerg,

      /// Alert
      alert,

      /// Critical
      crit,

      /// Error
      err,

      /// Warning
      warning,

      /// Notice
      notice,

      /// Info
      info,

      /// Debug
      debug
   };

   /** @brief Constructor
    *  @ingroup high-level-api
    *
    *  @param l Log level.
    */
   logger(level l = level::disabled)
   : level_{l}
   {}

   /** @brief Called when the resolve operation completes.
    *  @ingroup high-level-api
    *
    *  @param ec Error returned by the resolve operation.
    *  @param res Resolve results.
    */
   void on_resolve(system::error_code const& ec, asio::ip::tcp::resolver::results_type const& res);

   /** @brief Called when the connect operation completes.
    *  @ingroup high-level-api
    *
    *  @param ec Error returned by the connect operation.
    *  @param ep Endpoint to which the connection connected.
    */
   void on_connect(system::error_code const& ec, asio::ip::tcp::endpoint const& ep);

   /** @brief Called when the ssl handshake operation completes.
    *  @ingroup high-level-api
    *
    *  @param ec Error returned by the handshake operation.
    */
   void on_ssl_handshake(system::error_code const& ec);

   /** @brief Called when the connection is lost.
    *  @ingroup high-level-api
    *
    *  @param ec Error returned when the connection is lost.
    */
   void on_connection_lost(system::error_code const& ec);

   /** @brief Called when the write operation completes.
    *  @ingroup high-level-api
    *
    *  @param ec Error code returned by the write operation.
    *  @param payload The payload written to the socket.
    */
   void on_write(system::error_code const& ec, std::string const& payload);

   /** @brief Called when the read operation completes.
    *  @ingroup high-level-api
    *
    *  @param ec Error code returned by the read operation.
    *  @param n Number of bytes read.
    */
   void on_read(system::error_code const& ec, std::size_t n);

   /** @brief Called when the run operation completes.
    *  @ingroup high-level-api
    *
    *  @param reader_ec Error code returned by the read operation.
    *  @param writer_ec Error code returned by the write operation.
    */
   void on_run(system::error_code const& reader_ec, system::error_code const& writer_ec);

   /** @brief Called when the `HELLO` request completes.
    *  @ingroup high-level-api
    *
    *  @param ec Error code returned by the async_exec operation.
    *  @param resp Response sent by the Redis server.
    */
   void on_hello(system::error_code const& ec, generic_response const& resp);

   /** @brief Sets a prefix to every log message
    *  @ingroup high-level-api
    *
    *  @param prefix The prefix.
    */
   void set_prefix(std::string_view prefix)
   {
      prefix_ = prefix;
   }

   /** @brief Called when the runner operation completes.
    *  @ingroup high-level-api
    *
    *  @param run_all_ec Error code returned by the run_all operation.
    *  @param health_check_ec Error code returned by the health checker operation.
    *  @param hello_ec Error code returned by the health checker operation.
    */
   void
      on_runner(
         system::error_code const& run_all_ec,
         system::error_code const& health_check_ec,
         system::error_code const& hello_ec);

   void
      on_check_health(
         system::error_code const& ping_ec,
         system::error_code const& check_timeout_ec);

   void trace(std::string_view reason);

private:
   void write_prefix();
   level level_;
   std::string_view prefix_;
};

} // boost::redis

#endif // BOOST_REDIS_LOGGER_HPP