llcommandhandler.h

Go to the documentation of this file.

#ifndef LLCOMMANDHANDLER_H
#define LLCOMMANDHANDLER_H

/* To implement a command "foo" that takes one parameter,
   a UUID, do this:

class LLFooHandler : public LLCommandHandler
{
public:
    // Inform the system you handle commands starting
        // with "foo" and they are not allowed from external web
        // browser links.
        LLFooHandler() : LLCommandHandler("foo", false) { }

    // Your code here
        bool handle(const LLSD& tokens, const LLSD& queryMap)
        {
                if (tokens.size() < 1) return false;
                LLUUID id( tokens[0] );
                return doFoo(id);
        }
};

// Creating the object registers with the dispatcher.
LLFooHandler gFooHandler;
*/

class LLCommandHandler
{
public:
        LLCommandHandler(const char* command, bool allow_from_external_browser);
                // Automatically registers object to get called when 
                // command is executed.  All commands can be processed
                // in links from LLWebBrowserCtrl, but some (like teleport)
                // should not be allowed from outside the app.
                
        virtual ~LLCommandHandler();

        virtual bool handle(const LLSD& params,
                                                const LLSD& queryMap) = 0;
                // Execute the command with a provided (possibly empty)
                // list of parameters.
                // Return true if you did something, false if the parameters
                // are invalid or on error.
};


class LLCommandDispatcher
{
public:
        static bool dispatch(const std::string& cmd,
                                                 bool from_external_browser,
                                                 const LLSD& params,
                                                 const LLSD& queryMap);
                // Execute a command registered via the above mechanism,
                // passing string parameters.
                // Returns true if command was found and executed correctly.
};

#endif

---