libcore/include/sirikata/core/command/Commander.hpp

Go to the documentation of this file.

// Copyright (c) 2012 Sirikata Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can
// be found in the LICENSE file.

#ifndef _SIRIKATA_LIBCORE_COMMAND_COMMANDER_HPP_
#define _SIRIKATA_LIBCORE_COMMAND_COMMANDER_HPP_

#include <sirikata/core/command/Command.hpp>
#include <sirikata/core/util/Factory.hpp>
#include <sirikata/core/service/Context.hpp>
#include <boost/thread.hpp>

namespace Sirikata {
namespace Command {

class SIRIKATA_EXPORT Commander {
public:
    Commander();
    virtual ~Commander();

    virtual void registerCommand(const CommandKey& name, CommandHandler handler);
    virtual void unregisterCommand(const CommandKey& name);

    virtual void result(CommandID id, const Result& result) = 0;

  protected:
    CommandHandler getHandler(const CommandKey& name);

    // Meta commands -- commands the commander implements to allow getting data about itself
    void commandListCommands(const Command& cmd, Commander* cmdr, CommandID cmdid);

    typedef boost::recursive_mutex Mutex;
    typedef boost::lock_guard<Mutex> Lock;
    Mutex mMutex;

    typedef std::tr1::unordered_map<CommandKey, CommandHandler> HandlerMap;
    HandlerMap mHandlers;
}; // class Commandable


class DuplicateHandlerException : public std::exception {
public:
    DuplicateHandlerException() {}
    virtual ~DuplicateHandlerException() throw() {}

    char const* what() const throw() {
        return "Duplicate handler found during Commander registration";
    }
private:
};


class SIRIKATA_EXPORT CommanderFactory :
        public Factory2<Commander*, Context*, const String&>,
        public AutoSingleton<CommanderFactory>
{
  public:
    static CommanderFactory& getSingleton();
    static void destroy();
};

} // namespace Command
} // namespace Sirikata


#endif //_SIRIKATA_LIBCORE_COMMAND_COMMANDER_HPP_