Logo ROOT  
Reference Guide
RWebWindowsManager.hxx
Go to the documentation of this file.
1// Author: Sergey Linev <s.linev@gsi.de>
2// Date: 2017-10-16
3// Warning: This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!
4
5/*************************************************************************
6 * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
7 * All rights reserved. *
8 * *
9 * For the licensing terms see $ROOTSYS/LICENSE. *
10 * For the list of contributors see $ROOTSYS/README/CREDITS. *
11 *************************************************************************/
12
13#ifndef ROOT7_RWebWindowsManager
14#define ROOT7_RWebWindowsManager
15
16#include <memory>
17#include <string>
18#include <thread>
19#include <mutex>
20#include <functional>
21
22#include "THttpEngine.h"
23
24#include <ROOT/RWebWindow.hxx>
25
26class THttpServer;
27class THttpWSHandler;
28class TExec;
29
30namespace ROOT {
31namespace Experimental {
32
33/// function signature for catching show calls of arbitrary RWebWindow
34/// if returns true, normal show procedure will not be invoked
36
38
39 friend class RWebWindow;
40
41private:
42 std::unique_ptr<THttpServer> fServer; ///<! central communication with the all used displays
43 std::string fAddr; ///<! HTTP address of the server
44 std::recursive_mutex fMutex; ///<! main mutex, used for window creations
45 unsigned fIdCnt{0}; ///<! counter for identifiers
46 bool fUseHttpThrd{false}; ///<! use special thread for THttpServer
47 bool fUseSenderThreads{false}; ///<! use extra threads for sending data from RWebWindow to clients
48 float fLaunchTmout{30.}; ///<! timeout in seconds to start browser process, default 30s
49 bool fExternalProcessEvents{false}; ///<! indicate that there are external process events engine
50 std::unique_ptr<TExec> fAssgnExec; ///<! special exec to assign thread id via ProcessEvents
51 WebWindowShowCallback_t fShowCallback; ///<! function called for each RWebWindow::Show call
52
53 /// Returns true if http server use special thread for requests processing (default off)
54 bool IsUseHttpThread() const { return fUseHttpThrd; }
55
56 /// Returns true if extra threads to send data via websockets will be used (default off)
57 bool IsUseSenderThreads() const { return fUseSenderThreads; }
58
59 /// Returns timeout for launching new browser process
60 float GetLaunchTmout() const { return fLaunchTmout; }
61
62 void Unregister(RWebWindow &win);
63
64 /// Show window in specified location, see Show() method for more details
65 unsigned ShowWindow(RWebWindow &win, const RWebDisplayArgs &args);
66
67 int WaitFor(RWebWindow &win, WebWindowWaitFunc_t check, bool timed = false, double tm = -1);
68
69 std::string GetUrl(const RWebWindow &win, bool remote = false);
70
71 bool CreateServer(bool with_http = false);
72
74
75public:
77
79
80 /// Returns THttpServer instance
81 THttpServer *GetServer() const { return fServer.get(); }
82
83 /// Returns http address of the server, empty string when not available
84 std::string GetServerAddr() const { return fAddr; }
85
86 /// Assign show callback which can catch window showing, used by RBrowser
88
89 static std::shared_ptr<RWebWindowsManager> &Instance();
90
91 std::shared_ptr<RWebWindow> CreateWindow();
92
93 void Terminate();
94
95 static bool IsMainThrd();
96 static void AssignMainThrd();
97};
98
99} // namespace Experimental
100} // namespace ROOT
101
102#endif
Holds different arguments for starting browser with RWebDisplayHandle::Display() method.
Represents web window, which can be shown in web browser or any other supported environment.
Definition: RWebWindow.hxx:53
Central instance to create and show web-based windows like Canvas or FitPanel.
void AssignWindowThreadId(RWebWindow &win)
Assign thread id for window Required in case of external process events.
std::unique_ptr< THttpServer > fServer
! central communication with the all used displays
std::string GetUrl(const RWebWindow &win, bool remote=false)
Provide URL address to access specified window from inside or from remote.
bool CreateServer(bool with_http=false)
Creates http server, if required - with real http engine (civetweb) One could configure concrete HTTP...
float GetLaunchTmout() const
Returns timeout for launching new browser process.
RWebWindowsManager()
window manager constructor Required here for correct usage of unique_ptr<THttpServer>
int WaitFor(RWebWindow &win, WebWindowWaitFunc_t check, bool timed=false, double tm=-1)
Waits until provided check function or lambdas returns non-zero value Regularly calls WebWindow::Sync...
std::string GetServerAddr() const
Returns http address of the server, empty string when not available.
std::recursive_mutex fMutex
! main mutex, used for window creations
unsigned fIdCnt
! counter for identifiers
unsigned ShowWindow(RWebWindow &win, const RWebDisplayArgs &args)
Show window in specified location, see Show() method for more details.
std::string fAddr
! HTTP address of the server
bool fUseSenderThreads
! use extra threads for sending data from RWebWindow to clients
void Terminate()
Terminate http server and ROOT application.
~RWebWindowsManager()
window manager destructor Required here for correct usage of unique_ptr<THttpServer>
THttpServer * GetServer() const
Returns THttpServer instance.
WebWindowShowCallback_t fShowCallback
! function called for each RWebWindow::Show call
static void AssignMainThrd()
Re-assigns main thread id Normally main thread id recognized at the moment when library is loaded It ...
bool IsUseSenderThreads() const
Returns true if extra threads to send data via websockets will be used (default off)
std::unique_ptr< TExec > fAssgnExec
! special exec to assign thread id via ProcessEvents
bool IsUseHttpThread() const
Returns true if http server use special thread for requests processing (default off)
static bool IsMainThrd()
Returns true when called from main process Main process recognized at the moment when library is load...
static std::shared_ptr< RWebWindowsManager > & Instance()
Returns default window manager Used to display all standard ROOT elements like TCanvas or TFitPanel.
bool fUseHttpThrd
! use special thread for THttpServer
void Unregister(RWebWindow &win)
Release all references to specified window Called from RWebWindow destructor.
float fLaunchTmout
! timeout in seconds to start browser process, default 30s
bool fExternalProcessEvents
! indicate that there are external process events engine
void SetShowCallback(WebWindowShowCallback_t func)
Assign show callback which can catch window showing, used by RBrowser.
std::shared_ptr< RWebWindow > CreateWindow()
Creates new window To show window, RWebWindow::Show() have to be called.
TExec is a utility class that can be used to execute a C++ command when some event happens in a pad.
Definition: TExec.h:28
std::function< bool(RWebWindow &, const RWebDisplayArgs &)> WebWindowShowCallback_t
function signature for catching show calls of arbitrary RWebWindow if returns true,...
std::function< int(double)> WebWindowWaitFunc_t
function signature for waiting call-backs Such callback used when calling thread need to waits for so...
Definition: RWebWindow.hxx:48
void function(const Char_t *name_, T fun, const Char_t *docstring=0)
Definition: RExports.h:150
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...