1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
|
/*
Copyright (C) 2008 Bradley Arsenault
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef YOGServerRouterAdministratorCommand_h
#define YOGServerRouterAdministratorCommand_h
#include <string>
#include <vector>
#include "boost/shared_ptr.hpp"
class YOGServerRouterAdministrator;
class YOGServerRouter;
class YOGServerRouterPlayer;
///This defines a generic command
class YOGServerRouterAdministratorCommand
{
public:
virtual ~YOGServerRouterAdministratorCommand() {}
///Returns this YOGServerRouterAdministratorCommand help message
virtual std::string getHelpMessage()=0;
///Returns the command name for this YOGServerRouterAdministratorCommand
virtual std::string getCommandName()=0;
///Returns true if the given set of tokens match whats required for this YOGServerRouterAdministratorCommand
virtual bool doesMatch(const std::vector<std::string>& tokens)=0;
///Executes the code for the administrator command
virtual void execute(YOGServerRouter* router, YOGServerRouterAdministrator* admin, const std::vector<std::string>& tokens, YOGServerRouterPlayer* player)=0;
};
///This command hard shuts down the router
class YOGServerRouterAbortCommand : public YOGServerRouterAdministratorCommand
{
public:
///Returns this YOGServerRouterAbortCommand help message
std::string getHelpMessage();
///Returns the command name for this YOGServerRouterAbortCommand
std::string getCommandName();
///Returns true if the given set of tokens match whats required for this YOGServerRouterAbortCommand
bool doesMatch(const std::vector<std::string>& tokens);
///Executes the code for the administrator command
void execute(YOGServerRouter* router, YOGServerRouterAdministrator* admin, const std::vector<std::string>& tokens, YOGServerRouterPlayer* player);
};
///This command causes a router to disconnect from the server and turn off once all clients disconnecty
class YOGServerRouterShutdownCommand : public YOGServerRouterAdministratorCommand
{
public:
///Returns this YOGServerRouterShutdownCommand help message
std::string getHelpMessage();
///Returns the command name for this YOGServerRouterShutdownCommand
std::string getCommandName();
///Returns true if the given set of tokens match whats required for this YOGServerRouterShutdownCommand
bool doesMatch(const std::vector<std::string>& tokens);
///Executes the code for the administrator command
void execute(YOGServerRouter* router, YOGServerRouterAdministrator* admin, const std::vector<std::string>& tokens, YOGServerRouterPlayer* player);
};
///This command prints a status report of the YOG server
class YOGServerRouterStatusCommand : public YOGServerRouterAdministratorCommand
{
public:
///Returns this YOGServerRouterStatusCommand help message
std::string getHelpMessage();
///Returns the command name for this YOGServerRouterStatusCommand
std::string getCommandName();
///Returns true if the given set of tokens match whats required for this YOGServerRouterStatusCommand
bool doesMatch(const std::vector<std::string>& tokens);
///Executes the code for the administrator command
void execute(YOGServerRouter* router, YOGServerRouterAdministrator* admin, const std::vector<std::string>& tokens, YOGServerRouterPlayer* player);
};
#endif
|