THttpServer class. Sergey Linev (GSI)

Size: px

Start display at page:

Download "THttpServer class. Sergey Linev (GSI)"

Shawn Barrett
6 years ago
Views:

1 THttpServer class Sergey Linev (GSI)

2 Mtivatin Develpment was inspired by JSRtIO why nt achieve similar functinality with nline ROOT applicatin? first tests with external web servers dependencies frm external cde intrducing THttpServer class in ROOT ends up in rewriting JavaScript cde Available since mid 2014 in the ROOT5 and ROOT6 THttpServer class, ROOT Wrkshp

3 Simple example { // Create histgram, accessible via groot aut hpx = new TH1F("hpx","This is the px distributin",100,-4,4); // Create http server n prt 8080 aut serv = new THttpServer(" // run event lp while (!gsystem->prcessevents()) { hpx->fillrandm("gaus", 1000); } } THttpServer class, ROOT Wrkshp

hsimple.c screensht rt [0] new THttpServer( http:8080 ); rt [1].

4 hsimple.c screensht rt [0] new THttpServer( ); rt [1].x $ROOTSYS/tutrials/hsimple.C THttpServer class, ROOT Wrkshp

THttpServer functinality access t applicatin bjects files, canvases, histgrams via groot bjects culd be registered directly serv->register( /graphs, gr); prvides bjects data in different frmats

5 THttpServer functinality access t applicatin bjects files, canvases, histgrams via groot bjects culd be registered directly serv->register( /graphs, gr); prvides bjects data in different frmats binary, JSON, XML, image als access t bjects members executin f bjects methds user interface with JavaScript ROOT brwsing in bjects hierarchy bjects drawing live update (mnitring) f the bjects cntent THttpServer class, ROOT Wrkshp

6 Civetweb as http server Wrks n many platfrms Linux, Mac, Windws, Andrid,... Implements majr HTTP standards HTTP digest authrizatin, HTTPS/SSL, Websckets,... Several threads t handle incming requests Single surce file included in ROOT repsitry Open surce, MIT license Encapsulated in TCivetweb class THttpServer class, ROOT Wrkshp

7 threads safety Applicatin main thread Running cde: { // create bjects while (true) { gsystem->prcessevents(); // mdify bjects... } } THttpServer - cllect requests - prcess requests civetweb thread1 - prcess input request - submit it t THttpServer - wait fr result and send civetweb thread2 - prcess input request - submit it t THttpServer - wait fr result and send http http TRtSniffer - find bject per name - prduce reply civetweb thread3 - prcess input request - submit it t THttpServer - wait fr result and send http Objects access ONLY frm main thread THttpServer class, ROOT Wrkshp

8 TRtSniffer Cre functinality f THttpServer Always wrks in main applicatin thread Explre and access bjects hierarchy Prduces different representatin f the bjects Best place fr implementing user cde THttpServer class, ROOT Wrkshp

9 FastCGI supprt FastCGI is a binary prtcl fr interfacing interactive prgrams with a web server Allws t reuse web server functinality authrizatin security firewall caching... Implemented in TFastCGI class Can run in parallel t r instead f civetweb server THttpServer class, ROOT Wrkshp

10 FastCGI prxy FastCGI prtcl Applicatin main thread Running cde: { // create bjects while (true) { gsystem->prcessevents(); // mdify bjects... } } THttpServer - cllect requests - prcess requests Applicatin prcess FastCGI thread1 - prcess input request - submit t THttpServer - wait fr result and send FastCGI thread2 - prcess input request - submit t THttpServer - wait fr result and send TRtSniffer - find bject per name - prduce reply FastCGI thread3 - prcess input request - submit t THttpServer - wait fr result and send Apache http server http http http THttpServer class, ROOT Wrkshp

11 TBufferJSON Develped fr THttpServer but can be used independently Wrks similar t TBufferXML class but wrks nly in ne directin: bject -> JSON map majr ROOT cntainers in JS Array allws cnversin f bjects members prduces human-readable bjects representatin n special ROOT verhead as in XML can be used nt nly in JavaScript Prduced JSON culd be directly used in JSROOT fr drawing Let keep cmplex ROOT I/O n the server side n need fr binary I/O in JavaScript custm streamer can be equip with special calls (see TCanvas) n need fr custm streamers in JavaScript THttpServer class, ROOT Wrkshp

12 JSON examples { } "_typename" : "TAttText", "ftextangle" : 0, "ftextsize" : 5.0e-02, "ftextalign" : 11, "ftextclr" : 1, "ftextfnt" : 62 { "_typename": "TH1F", "funiqueid": 0, "fbits": , "fname": "hpx", "ftitle": "This is the px distributin", "flineclr": 602, "flinestyle": 1, "flinewidth": 1, "ffillclr": 48, "ffillstyle": 1001, "fmarkerclr": 1, "fmarkerstyle": 1, "fmarkersize": 1, "fncells": 102, "fxaxis": { "_typename": "TAxis", "funiqueid": 0, "fbits": , "fname": "xaxis",... THttpServer class, ROOT Wrkshp

13 http requests Every registered bject has its wn URL like Fllwing requests are implemented: rt.jsn bject data in JSON frmat (TBufferJSON) rt.bin bject data in binary frmat (TBufferFile) rt.xml bject data in XML frmat (TBufferXML) rt.png bject drawing n TCanvas exe.jsn bjects methd executin exe.bin bjects methd executin, result in binary frm cmd.jsn executin registered t server cmmands item.jsn extra bjects prperties, cnfigured n the server h.jsn bjects hierarchy descriptin h.xml bjects hierarchy in XML Data can be cmpressed prviding.gz extensin THttpServer class, ROOT Wrkshp

14 http requests examples Object in JSON frmat Cmpact and cmpressed JSON Object member (ftitle) in JSON frmat Object as image Executing bject methd THttpServer class, ROOT Wrkshp

15 Objects methd executin With exe.jsn r exe.bin requests als exe.txt fr debug purpses Methd arguments specified as URL parameters One can chse methd prttype imprtant when several methds with the same name exists One can pass ROOT bject as argument in binary r XML frmat Best way t access custm functinality via http but access shuld be granted (default ff) Used fr remte TTree::Draw() calling prttype="optin_t*"&pt="px:py>>h1"&_ret_bject_=h1 THttpServer class, ROOT Wrkshp

16 Remte TTree::Draw THttpServer class, ROOT Wrkshp

17 Access cntrl By default server started in read-nly mde nly bjects data can be accessed methds can nt be executed One can allw access t bjects, flders r methds serv->restrict("/hpx", "allw=admin"); // allw full access fr user with 'admin' accunt serv->restrict("/hpx", "allw=all"); // allw full access fr all users serv->restrict("/hpx", "allw_methd=rebin"); // allw nly Rebin methd Based n authrized user names either htdigest f civetweb r user name prvided by FastCGI One culd disable read-nly mde cmpletely serv->setreadonly(kfalse); f curse, nt recmmended THttpServer class, ROOT Wrkshp

18 Cmmand interface Simple way t trigger actin frm web brwser Bl_t flag = kfalse;... serv->registercmmand( /flip, flag=!flag; ); Appear as buttn in web GUI activated by muse click Wrks als in read-nly server mde access can be restricted fr specific users One can register cmmands with arguments argument will be interactively requested in brwser Cmmand can be invked directly with request THttpServer class, ROOT Wrkshp

19 Equip user applicatin with http Level 0: d nthing just create THttpServer instance Level 1: register user bjects Level 2: add several cmmands Level 3: supprt user classes write JavaScript cde set autlad prperties subclass TRtSniffer (t explre user cllectins) example g4 framewrk THttpServer class, ROOT Wrkshp

20 Alternatives t web brwser? http Applicatin main thread Running cde: { // create bjects while (true) { gsystem->prcessevents(); // mdify bjects... } } THttpServer - cllect requests - prcess requests civetweb thread1 - prcess input request - submit t THttpServer - wait fr result and send civetweb thread2 - prcess input request - submit t THttpServer - wait fr result and send http web brwser shell scripts TRtSniffer - find bject per name - prduce reply civetweb thread3 - prcess input request - submit t THttpServer - wait fr result and send http g4 GUI* * see als talk f Jern Adamczewski-Musch later tday THttpServer class, ROOT Wrkshp

THttpServer manual Useful links https://rt.cern.ch/drupal/cntent/httpserver-manual-600 https://github.cm/linev/jsrt/blb/master/dcs/httpserver.md Class dcumentatin fr: https://rt.cern.ch/rt/html/thttpserver.

21 THttpServer manual Useful links Class dcumentatin fr: Several tutrials: $ROOTSYS/tutrials/http Applicatin snapshts: THttpServer class, ROOT Wrkshp

Contents. HTTP Server 3

Contents. HTTP Server 3 Contents HTTP Server 3 1 HTTP server in ROOT 5 1.1 Starting the HTTP server.............................................. 5 1.2 Registering objects.................................................. 6 1.3