Loading...
Helix SwarmHelix Swarm
Loading...

index.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • index.html #1
  • View
  • Commits
  • Open Download .zip Download (3 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  6. <title>
  7.   File: README
  8.   
  9.     &mdash; Documentation by YARD 0.8.7.6
  10.   
  11. </title>
  12.  
  13.   <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
  14.  
  15.   <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
  16.  
  17. <script type="text/javascript" charset="utf-8">
  18.   hasFrames = window.top.frames.main ? true : false;
  19.   relpath = '';
  20.   framesUrl = "frames.html#!file.README.html";
  21. </script>
  22.  
  23.  
  24.   <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
  25.  
  26.   <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
  27.  
  28.  
  29.   </head>
  30.   <body>
  31.     <div id="header">
  32.       <div id="menu">
  33.   
  34.     <a href="_index.html">Index</a> &raquo; 
  35.     <span class="title">File: README</span>
  36.   
  37.  
  38.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  39. </div>
  40.  
  41.       <div id="search">
  42.   
  43.     <a class="full_list_link" id="class_list_link"
  44.         href="class_list.html">
  45.       Class List
  46.     </a>
  47.   
  48.     <a class="full_list_link" id="method_list_link"
  49.         href="method_list.html">
  50.       Method List
  51.     </a>
  52.   
  53.     <a class="full_list_link" id="file_list_link"
  54.         href="file_list.html">
  55.       File List
  56.     </a>
  57.   
  58. </div>
  59.       <div class="clear"></div>
  60.     </div>
  61.  
  62.     <iframe id="search_frame"></iframe>
  63.  
  64.     <div id="content"><div id='filecontents'>
  65. <h2 id="label-Helix+Web+Services+-28HWS-29">Helix Web Services (HWS)</h2>
  66.  
  67. <p>Please note this is <strong>alpha</strong> software.</p>
  68.  
  69. <p>Helix Web Services creates a series of service APIs exposed via web
  70. technologies, such as HTTP and WebSocket.</p>
  71.  
  72. <p>Official deployment and documentation is in progress.</p>
  73.  
  74. <h2 id="label-Architectural+Overview">Architectural Overview</h2>
  75.  
  76. <p>The core of Web Services is a single Ruby HTTP web application server. The
  77. main server is a Sinatra modular project, that mounts many other services,
  78. also implemented as Sinatra modular projects. Services can be implemented
  79. as generic Rack middleware, we just use Sinatra for the most part.</p>
  80.  
  81. <p>Access to the Perforce server should be isolated to the core
  82. <code>perforce</code> service.</p>
  83.  
  84. <p>Each service has access to using a locally running PostgreSQL server for
  85. caching data that can be indexed in interesting ways. There is one
  86. PostgreSQL DB in use - web_services - for the purposes of caching.</p>
  87.  
  88. <p>Background processes are used as well. These are Sidekiq workers. Redis is
  89. used as the queuing engine binding these together.</p>
  90. </div></div>
  91.  
  92.     <div id="footer">
  93.   Generated on Tue Sep 15 01:20:27 2015 by
  94.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  95.   0.8.7.6 (ruby-2.2.3).
  96. </div>
  97.  
  98.   </body>
  99. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago