ArNetServer.h

/*
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 ARNETSERVER_H
#define ARNETSERVER_H

#include "ariaTypedefs.h"
#include "ArSocket.h"
#include "ArFunctor.h"
#include "ariaUtil.h"
#include <list>


class ArRobot;

class ArArgumentBuilder;


class ArNetServer
{
public:
  AREXPORT ArNetServer(bool addAriaExitCB = true);
  AREXPORT ~ArNetServer();
  
  AREXPORT bool open(ArRobot *robot, unsigned int port, 
             const char *password, bool multipleClients = true,
             const char *openOnIP = NULL);

  AREXPORT void close(void);

  AREXPORT bool addCommand(const char *command, 
               ArFunctor3<char **, int, ArSocket *> *functor, 
               const char *help);

  AREXPORT bool remCommand(const char *command);

#ifndef SWIG

  AREXPORT void sendToAllClients(const char *str, ...);
#endif

  AREXPORT void sendToAllClientsPlain(const char *str);

#ifndef SWIG

  AREXPORT void sendToClient(ArSocket *socket, const char *ipString,
                 const char *str, ...);
#endif

  AREXPORT void sendToClientPlain(ArSocket *socket, const char *ipString,
                  const char *str);

  AREXPORT bool isOpen(void);

  AREXPORT void setLoggingDataSent(bool loggingData);
  
  AREXPORT bool getLoggingDataSent(void);

  AREXPORT void setLoggingDataReceived(bool loggingData);
  
  AREXPORT bool getLoggingDataReceived(void);


  AREXPORT void runOnce(void);

  AREXPORT void internalGreeting(ArSocket *socket);
  
  AREXPORT void internalHelp(ArSocket *socket);
  AREXPORT void internalHelp(char **argv, int argc, ArSocket *socket);
  AREXPORT void internalEcho(char **argv, int argc, ArSocket *socket);
  AREXPORT void internalQuit(char **argv, int argc, ArSocket *socket);
  AREXPORT void internalShutdownServer(char **argv, int argc, 
                       ArSocket *socket);
  AREXPORT void parseCommandOnSocket(ArArgumentBuilder *args, 
                     ArSocket *socket, bool allowLog = true);
  AREXPORT void internalAddSocketToList(ArSocket *socket);
  AREXPORT void internalAddSocketToDeleteList(ArSocket *socket);
  AREXPORT void squelchNormal(void);
  AREXPORT void setExtraString(const char *str) { myExtraString = str; }
  AREXPORT const char *getExtraString(void) { return myExtraString.c_str(); }
  AREXPORT int lock() {return(myMutex.lock());}
  AREXPORT int tryLock() {return(myMutex.tryLock());}
  AREXPORT int unlock() {return(myMutex.unlock());}

protected:
  ArMutex myMutex;
  std::map<std::string, ArFunctor3<char **, int, ArSocket *> *, ArStrCaseCmpOp> myFunctorMap;
  std::map<std::string, std::string, ArStrCaseCmpOp> myHelpMap;
  bool myLoggingDataSent;
  bool myLoggingDataReceived;
  bool myOpened;
  bool myWantToClose;
  bool mySquelchNormal;
  ArSocket myServerSocket;
  ArRobot *myRobot;
  std::string myPassword;
  bool myMultipleClients;
  unsigned int myPort;
  std::string myExtraString;
  std::list<ArSocket *> myConns;
  std::list<ArSocket *> myConnectingConns;
  std::list<ArSocket *> myDeleteList;
  ArFunctorC<ArNetServer> myTaskCB;
  ArFunctor3C<ArNetServer, char **, int, ArSocket *> myHelpCB;
  ArFunctor3C<ArNetServer, char **, int, ArSocket *> myEchoCB;
  ArFunctor3C<ArNetServer, char **, int, ArSocket *> myQuitCB;
  ArFunctor3C<ArNetServer, char **, int, ArSocket *> myShutdownServerCB;
  ArFunctorC<ArNetServer> myAriaExitCB;
};

#endif // ARNETSERVER_H

---