view lib/irccd/cmd-plugin-reload.h @ 86:39fe49d294c8

Docs: add lot of doxygen documentation, #453
author David Demelier <markand@malikania.fr>
date Tue, 05 Apr 2016 23:01:35 +0200
parents 969f30acfb0e
children
line wrap: on
line source

/*
 * cmd-plugin-reload.h -- implementation of plugin-reload transport command
 *
 * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef IRCCD_CMD_PLUGIN_RELOAD_H
#define IRCCD_CMD_PLUGIN_RELOAD_H

/**
 * @file cmd-plugin-reload.h
 * @brief Implementation of plugin-reload transport command.
 */

#include "command.h"

namespace irccd {

namespace command {

/**
 * @class PluginReload
 * @brief Implementation of plugin-reload transport command.
 */
class PluginReload : public RemoteCommand {
public:
	/**
	 * Constructor.
	 */
	PluginReload();

	/**
	 * @copydoc RemoteCommand::help
	 */
	std::string help() const override;

	/**
	 * @copydoc RemoteCommand::args
	 */
	std::vector<Arg> args() const override;

	/**
	 * @copydoc RemoteCommand::exec
	 */
	json::Value exec(Irccd &irccd, const json::Value &request) const override;
};

} // !command

} // !irccd

#endif // !IRCCD_CMD_PLUGIN_RELOAD_H