ArServerHandlerCommands.h

Go to the documentation of this file.

/*
MobileRobots Advanced Robotics Interface for Applications (ARIA)
Copyright (C) 2004, 2005 ActivMedia Robotics LLC
Copyright (C) 2006, 2007 MobileRobots Inc.

     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 2 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

If you wish to redistribute ARIA under different terms, contact 
MobileRobots for information about a commercial version of ARIA at 
robots@mobilerobots.com or 
MobileRobots Inc, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
*/

#ifndef ARSERVERHANDLERCOMMANDS_H
#define ARSERVERHANDLERCOMMANDS_H

#include "Aria.h"
#include "ArServerBase.h"


class ArServerHandlerCommands
{
public:
  AREXPORT ArServerHandlerCommands(ArServerBase *server);
  AREXPORT virtual ~ArServerHandlerCommands();
  AREXPORT bool addCommand(const char *name, const char *description,
                           ArFunctor *functor, 
                           const char *commandGroup = NULL);
  AREXPORT bool addStringCommand(const char *name, const char *description,
                                 ArFunctor1<ArArgumentBuilder *> *functor, 
                                 const char *commandGroup = NULL);
  AREXPORT void setPrefix(const char *prefix);
  AREXPORT const char *getPrefix(void);
  AREXPORT void netListCommands(ArServerClient *client, ArNetPacket *packet);
  AREXPORT void netListStringCommands(ArServerClient *client, 
                                      ArNetPacket *packet);
  
protected:
  ArServerBase *myServer;
  void netParseCommand(ArServerClient *client, ArNetPacket *packet, 
                       ArFunctor *functor);
  void netParseStringCommand(ArServerClient *client, ArNetPacket *packet, 
                             ArFunctor1<ArArgumentBuilder *> *functor);
  std::list<std::string> myCommands;
  std::list<std::string> myCommandDescriptions;
  std::list<std::string> myStringCommands;
  std::list<std::string> myStringCommandDescriptions;
  std::string myPrefix;
  ArFunctor2C<ArServerHandlerCommands, 
      ArServerClient *, ArNetPacket *> myNetListCommandsCB;
  ArFunctor2C<ArServerHandlerCommands, 
      ArServerClient *, ArNetPacket *> myNetListStringCommandsCB;
};

#endif 

---