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

#ifndef AEDIS_SENTINEL_COMMAND_HPP
#define AEDIS_SENTINEL_COMMAND_HPP

#include <ostream>

namespace aedis {
namespace sentinel {

/** \brief Sentinel commands.
 *  \ingroup any
 *
 *  For a full list of commands see https://redis.io/topics/sentinel
 *
 *  \remark The list of commands below are read from Redis with the
 *  help of the command \c command.
 */
enum class command {
   /// https://redis.io/commands/acl
   acl,
   /// https://redis.io/commands/auth
   auth,
   /// https://redis.io/commands/client
   client,
   /// https://redis.io/commands/command
   command,
   /// https://redis.io/commands/hello
   hello,
   /// https://redis.io/commands/info
   info,
   /// https://redis.io/commands/ping
   ping,
   /// https://redis.io/commands/psubscribe
   psubscribe,
   /// https://redis.io/commands/publish
   publish,
   /// https://redis.io/commands/punsubscribe
   punsubscribe,
   /// https://redis.io/commands/role
   role,
   /// https://redis.io/topics/sentinel
   sentinel,
   /// https://redis.io/commands/shutdown
   shutdown,
   /// https://redis.io/commands/subscribe
   subscribe,
   /// https://redis.io/commands/unsubscribe
   unsubscribe,
   /// Unknown/invalid command.
   invalid,
};

/** \brief Converts a sentinel command to a string
 *  \ingroup any
 *
 *  \param c The command to convert.
 */
char const* to_string(command c);

/** \brief Write the text for a sentinel command name to an output stream.
 *  \ingroup operators
 *
 *  \param os Output stream.
 *  \param c Sentinel command
 */
std::ostream& operator<<(std::ostream& os, command c);

/** \brief Returns true for sentinel commands with push response.
 *  \ingroup any
 */
bool has_push_response(command cmd);

} // sentinel
} // aedis

#endif // AEDIS_SENTINEL_COMMAND_HPP