ArServerHandlerConfig.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 ARSERVERCONFIGHANDLER_H
#define ARSERVERCONFIGHANDLER_H

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

class ArServerClient;


class ArServerHandlerConfig
{
public:


  AREXPORT ArServerHandlerConfig(ArServerBase *server, 
                                 ArConfig *config,
                                                         const char *defaultFile = NULL, 
                                                         const char *defaultFileBaseDirectory = NULL);

  AREXPORT virtual ~ArServerHandlerConfig();

  // ---------------------------------------------------------------------------
  // Network Packet Handlers 
  // ---------------------------------------------------------------------------

  AREXPORT void reloadConfig(ArServerClient *client, ArNetPacket *packet);

  AREXPORT void getConfigBySections(ArServerClient *client, ArNetPacket *packet);

  AREXPORT void getConfig(ArServerClient *client, ArNetPacket *packet);
  
  AREXPORT void setConfig(ArServerClient *client, ArNetPacket *packet);

  AREXPORT void getConfigDefaults(ArServerClient *client, ArNetPacket *packet);

  AREXPORT void getConfigSectionFlags(ArServerClient *client, 
                                      ArNetPacket *packet);

  // ---------------------------------------------------------------------------
  // Callback Methods
  // ---------------------------------------------------------------------------

  AREXPORT void addPreWriteCallback(ArFunctor *functor, 
                                    ArListPos::Pos position = ArListPos::LAST);
  AREXPORT void remPreWriteCallback(ArFunctor *functor);

  AREXPORT void addPostWriteCallback(ArFunctor *functor, 
                                     ArListPos::Pos position = ArListPos::LAST);
  AREXPORT void remPostWriteCallback(ArFunctor *functor);  

  AREXPORT void addConfigUpdatedCallback(ArFunctor *functor, 
                                  ArListPos::Pos position = ArListPos::LAST);
  AREXPORT void remConfigUpdatedCallback(ArFunctor *functor);  

  AREXPORT int lockConfig(void) { return myConfigMutex.lock(); }
  AREXPORT int tryLockConfig(void) { return myConfigMutex.tryLock(); }
  AREXPORT int unlockConfig(void) { return myConfigMutex.unlock(); }

  AREXPORT bool writeConfig(void);
  AREXPORT bool configUpdated(ArServerClient *client = NULL);


  AREXPORT bool loadDefaultsFromFile(void);
  AREXPORT bool loadDefaultsFromPacket(ArNetPacket *packet);
  AREXPORT void createEmptyConfigDefaults(void);
protected:

  AREXPORT void handleGetConfig(ArServerClient *client, 
                                ArNetPacket *packet,
                                bool isMultiplePackets);

  bool internalSetConfig(ArServerClient *client, ArNetPacket *packet);

  void createDefaultConfig(const char *defaultFileBaseDir);
  void addDefaultServerCommands(void);

  ArServerBase *myServer;
  ArConfig *myConfig;


  ArConfig *myDefault;
  std::string myDefaultFile;
  std::string myDefaultFileBaseDir;
  ArMutex myDefaultConfigMutex;
  bool myAddedDefaultServerCommands;

  ArMutex myConfigMutex;
  
  std::list<ArFunctor *> myPreWriteCallbacks;
  std::list<ArFunctor *> myPostWriteCallbacks;
  std::list<ArFunctor *> myConfigUpdatedCallbacks;

  ArFunctor2C<ArServerHandlerConfig, ArServerClient*, ArNetPacket *> myGetConfigBySectionsCB;
  ArFunctor2C<ArServerHandlerConfig, ArServerClient*, ArNetPacket *> myGetConfigCB;
  ArFunctor2C<ArServerHandlerConfig, ArServerClient*, ArNetPacket *> mySetConfigCB;
  ArFunctor2C<ArServerHandlerConfig, ArServerClient*, ArNetPacket *> myReloadConfigCB;
  ArFunctor2C<ArServerHandlerConfig, ArServerClient*, ArNetPacket *> myGetConfigDefaultsCB;
  ArFunctor2C<ArServerHandlerConfig, ArServerClient*, ArNetPacket *> myGetConfigSectionFlagsCB;

};

#endif

---