/********************************************************************
 * The Data Acquisition Backbone Core (DABC)
 ********************************************************************
 * Copyright (C) 2009-
 * GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
 * Planckstr. 1
 * 64291 Darmstadt
 * Germany
 * Contact:  http://dabc.gsi.de
 ********************************************************************
 * This software can be used under the GPL license agreements as stated
 * in LICENSE.txt file which is part of the distribution.
 ********************************************************************/
#ifndef DabcRoot_h
#define DabcRoot_h

class TObject;

/** Interface to DABC framework.
 *  Kept for compatibility.
 *  It is recommended to use THttpServer class, which provides the same
 *  functionality via TDabcEngine.
 */

class DabcRoot {

   public:

      /** \brief Set name of top server folder
       *
       * Should be called before server start. Default name is "ROOT" */
      static void SetTopFolderName(const char* name);


      /** \brief Method starts HTTP server in ROOT session
       *
       * \param[in] port         http port number, 8080 is default
       * \param[in] sync_timer   kind of TTimer object to use, default true
       * \returns                true if successful
       *
       * After method call one could in any web browser open page with
       * address http://your_host_name:port and browse objects registered in gROOT directory.
       * It is all histograms, canvases, files. If necessary, one could add own objects to gROOT.
       *
       * sync_timer parameter defines that kind of timer is used. When true (default),
       * synchronous timer is created which can process http-server commands only when
       * gSystem->ProcessEvents() are called. It is a case in normal ROOT session and it is
       * recommended way of working. Advantage - one exactly knows and can control
       * when http server can interrupt program execution.
       *
       * If no any gSystem->ProcessEvents() calls provided in user code and
       * it is not possible to add such code, one should use asynchronous timer.
       * Such timer may lead to problems on objects streaming,
       * while asynchronous timer can interrupt program at any point of execution  */

      static bool StartHttpServer(int port = 8080, bool sync_timer = true);

      /** \brief Method starts DABC server
       *
       * \param[in] port           socket port number, default 1237
       * \param[in] sync_timer     kind of TTimer object to use, default true
       * \param[in] allow_slaves   if true, other processes could be attached (default false)
       * \returns                  true if successful
       *
       * To access such server, one could use Go4 GUI or shell-based tools.
       * DABC server could be started together with HTTP server.
       *
       * sync_timer parameter defines that kind of timer is used. When true (default),
       * synchronous timer is created which can process incoming commands only when
       * gSystem->ProcessEvents() are called. It is a case in normal ROOT session and it is
       * recommended way of working. Advantage - one exactly knows and can control
       * when DABC server can interrupt program execution.
       *
       * allow_slaved parameter allows to connect other processes to this applications.
       * It make possible to access such slave processes via main server */

      static bool StartDabcServer(int port = 1237, bool sync_timer = true, bool allow_slaves = false);


      /** \brief Assign master DABC node
       *
       * \param[in] master_url   socket address of the DABC master node
       * \param[in] sync_timer   kind of TTimer object to use, default true
       * \returns                true if successful
       *
       * Instead of providing direct http port, any ROOT analysis can deliver
       * information to master DABC node, which is normally HTTP server for many client processes
       *
       * Advantage of such methods that many clients can be connected to the same server
       * and their data will be seen in the same hierarchical structure via the browser
       *
       * Meaning of sync_timer variable see in \ref DabcRoot::StartHttpServer() documentation */

      static bool ConnectMaster(const char* master_url, bool sync_timer = true);


      /** \brief Register objects in web server
       *
       * Allows to register arbitrary object in web server. One also can specify sub-folder name,
       * where objects will be contained */
      static bool Register(const char* folder, TObject* obj);

      /** \brief Remove object from registered list */
      static bool Unregister(TObject* obj);


      /** \brief Switch on/off DABC debug output */
      static void EnableDebug(bool on = true);
};

#endif