Helix SwarmHelix Swarm

ClientService.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • HelixSync/
  • ClientService.html #1
  • View
  • Commits
  • Open Download .zip Download (13 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.   Class: HelixSync::ClientService
  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#!HelixSync/ClientService.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 (C)</a> &raquo;
  35.     <span class='title'><span class='object_link'><a href="../HelixSync.html" title="HelixSync (module)">HelixSync</a></span></span>
  36.      &raquo; 
  37.     <span class="title">ClientService</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="../class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="../method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="../file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Class: HelixSync::ClientService
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.     <dt class="r1">Inherits:</dt>
  75.     <dd class="r1">
  76.       <span class="inheritName">Object</span>
  77.       
  78.         <ul class="fullTree">
  79.           <li>Object</li>
  80.           
  81.             <li class="next">HelixSync::ClientService</li>
  82.           
  83.         </ul>
  84.         <a href="#" class="inheritanceTree">show all</a>
  85.       
  86.       </dd>
  87.     
  88.   
  89.   
  90.     
  91.   
  92.     
  93.   
  94.   
  95.   
  96.     <dt class="r2 last">Defined in:</dt>
  97.     <dd class="r2 last">lib/helix_sync/client_service.rb</dd>
  98.   
  99. </dl>
  100. <div class="clear"></div>
  101.  
  102. <h2>Overview</h2><div class="docstring">
  103.   <div class="discussion">
  104.     
  105. <p>Provides a mechanism for managing client workspaces for projects.</p>
  106.  
  107.  
  108.   </div>
  109. </div>
  110. <div class="tags">
  111.   
  112.  
  113. </div>
  114.   <h2>Constant Summary</h2>
  115.   
  116.     <dl class="constants">
  117.       
  118.         <dt id="handle_create_client-classvariable" class="">@@handle_create_client =
  119.           
  120.         </dt>
  121.         <dd><pre class="code"><span class='lbracket'>[</span><span class='rbracket'>]</span></pre></dd>
  122.       
  123.     </dl>
  124.   
  125.  
  126.  
  127.  
  128.  
  129.   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
  130.   <ul class="summary">
  131.     
  132.       <li class="public ">
  133.   <span class="summary_signature">
  134.     
  135.       <a href="#env-instance_method" title="#env (instance method)">- (Object) <strong>env</strong> </a>
  136.     
  137.  
  138.     
  139.   </span>
  140.   
  141.   
  142.   
  143.     
  144.     
  145.   
  146.   
  147.   
  148.   
  149.   
  150.  
  151.   
  152.     <span class="summary_desc"><div class='inline'>
  153. <p>Rack environment.</p>
  154. </div></span>
  155.   
  156. </li>
  157.  
  158.     
  159.   </ul>
  160.  
  161.  
  162.  
  163.  
  164.   
  165.     <h2>
  166.       Class Method Summary
  167.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  168.     </h2>
  169.  
  170.     <ul class="summary">
  171.       
  172.         <li class="public ">
  173.   <span class="summary_signature">
  174.     
  175.       <a href="#handle_create_client-class_method" title="handle_create_client (class method)">+ (Object) <strong>handle_create_client</strong> </a>
  176.     
  177.  
  178.     
  179.   </span>
  180.   
  181.   
  182.   
  183.   
  184.   
  185.   
  186.   
  187.  
  188.   
  189.     <span class="summary_desc"><div class='inline'>
  190. <p>Callback methods that can implement client workspace creation based on
  191. projects.</p>
  192. </div></span>
  193.   
  194. </li>
  195.  
  196.       
  197.     </ul>
  198.   
  199.     <h2>
  200.       Instance Method Summary
  201.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  202.     </h2>
  203.  
  204.     <ul class="summary">
  205.       
  206.         <li class="public ">
  207.   <span class="summary_signature">
  208.     
  209.       <a href="#create_client-instance_method" title="#create_client (instance method)">- (Object) <strong>create_client</strong>(project, device, root) </a>
  210.     
  211.  
  212.     
  213.   </span>
  214.   
  215.   
  216.   
  217.   
  218.   
  219.   
  220.   
  221.  
  222.   
  223.     <span class="summary_desc"><div class='inline'>
  224. <p>Create a client for the project.</p>
  225. </div></span>
  226.   
  227. </li>
  228.  
  229.       
  230.         <li class="public ">
  231.   <span class="summary_signature">
  232.     
  233.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (ClientService) <strong>initialize</strong>(env: nil) </a>
  234.     
  235.  
  236.     
  237.   </span>
  238.   
  239.   
  240.     <span class="note title constructor">constructor</span>
  241.   
  242.   
  243.   
  244.   
  245.   
  246.   
  247.  
  248.   
  249.     <span class="summary_desc"><div class='inline'>
  250. <p>A new instance of ClientService.</p>
  251. </div></span>
  252.   
  253. </li>
  254.  
  255.       
  256.         <li class="public ">
  257.   <span class="summary_signature">
  258.     
  259.       <a href="#p4-instance_method" title="#p4 (instance method)">- (Object) <strong>p4</strong> </a>
  260.     
  261.  
  262.     
  263.   </span>
  264.   
  265.   
  266.   
  267.   
  268.   
  269.   
  270.   
  271.  
  272.   
  273.     <span class="summary_desc"><div class='inline'></div></span>
  274.   
  275. </li>
  276.  
  277.       
  278.     </ul>
  279.   
  280.  
  281. <div id="constructor_details" class="method_details_list">
  282.   <h2>Constructor Details</h2>
  283.   
  284.     <div class="method_details first">
  285.   <h3 class="signature first" id="initialize-instance_method">
  286.   
  287.     - (<tt><span class='object_link'><a href="" title="HelixSync::ClientService (class)">ClientService</a></span></tt>) <strong>initialize</strong>(env: nil) 
  288.   
  289.  
  290.   
  291.  
  292.   
  293. </h3><div class="docstring">
  294.   <div class="discussion">
  295.     
  296. <p>Returns a new instance of ClientService</p>
  297.  
  298.  
  299.   </div>
  300. </div>
  301. <div class="tags">
  302.   
  303.  
  304. </div><table class="source_code">
  305.   <tr>
  306.     <td>
  307.       <pre class="lines">
  308.  
  309.  
  310. 8
  311. 9
  312. 10</pre>
  313.     </td>
  314.     <td>
  315.       <pre class="code"><span class="info file"># File 'lib/helix_sync/client_service.rb', line 8</span>
  316.  
  317. <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>env:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  318.   <span class='ivar'>@env</span> <span class='op'>=</span> <span class='id identifier rubyid_env'>env</span>
  319. <span class='kw'>end</span></pre>
  320.     </td>
  321.   </tr>
  322. </table>
  323. </div>
  324.   
  325. </div>
  326.  
  327.   <div id="instance_attr_details" class="attr_details">
  328.     <h2>Instance Attribute Details</h2>
  329.     
  330.       
  331.       <span id="env=-instance_method"></span>
  332.       <div class="method_details first">
  333.   <h3 class="signature first" id="env-instance_method">
  334.   
  335.     - (<tt>Object</tt>) <strong>env</strong> 
  336.   
  337.  
  338.   
  339.  
  340.   
  341. </h3><div class="docstring">
  342.   <div class="discussion">
  343.     
  344. <p>Rack environment</p>
  345.  
  346.  
  347.   </div>
  348. </div>
  349. <div class="tags">
  350.   
  351.  
  352. </div><table class="source_code">
  353.   <tr>
  354.     <td>
  355.       <pre class="lines">
  356.  
  357.  
  358. 6
  359. 7
  360. 8</pre>
  361.     </td>
  362.     <td>
  363.       <pre class="code"><span class="info file"># File 'lib/helix_sync/client_service.rb', line 6</span>
  364.  
  365. <span class='kw'>def</span> <span class='id identifier rubyid_env'>env</span>
  366.   <span class='ivar'>@env</span>
  367. <span class='kw'>end</span></pre>
  368.     </td>
  369.   </tr>
  370. </table>
  371. </div>
  372.     
  373.   </div>
  374.  
  375.  
  376.   <div id="class_method_details" class="method_details_list">
  377.     <h2>Class Method Details</h2>
  378.  
  379.     
  380.       <div class="method_details first">
  381.   <h3 class="signature first" id="handle_create_client-class_method">
  382.   
  383.     + (<tt>Object</tt>) <strong>handle_create_client</strong> 
  384.   
  385.  
  386.   
  387.  
  388.   
  389. </h3><div class="docstring">
  390.   <div class="discussion">
  391.     
  392. <p>Callback methods that can implement client workspace creation based on
  393. projects.</p>
  394.  
  395. <p>Each callback should take 4 parameters:</p>
  396. <ul><li>
  397. <p><code>project</code> [String] The project ID.</p>
  398. </li><li>
  399. <p><code>device</code> [String] A device ID (like a hostname or MAC address)
  400. that  we&#39;ll associate with the client.</p>
  401. </li><li>
  402. <p><code>root</code> [String] The Root field of the client, the base directory
  403. for  the new setting.</p>
  404. </li><li>
  405. <p><code>env</code> [Hash] The rack environment</p>
  406. </li></ul>
  407.  
  408. <p>Your callback should return the new client name if it&#39;s been handled.</p>
  409.  
  410. <p>It&#39;s assumed that your implementation will handle other defaults
  411. responsibly.</p>
  412.  
  413. <p>Example:</p>
  414.  
  415. <pre class="code ruby"><code class="ruby"><span class='const'>HelixSync</span><span class='op'>::</span><span class='const'>ClientService</span><span class='period'>.</span><span class='id identifier rubyid_handle_create_client'>handle_create_client</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_project'>project</span><span class='comma'>,</span> <span class='id identifier rubyid_device'>device</span><span class='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='comma'>,</span> <span class='id identifier rubyid_env'>env</span><span class='op'>|</span>
  416.   <span class='id identifier rubyid_client_name'>client_name</span> <span class='op'>=</span> <span class='id identifier rubyid_go_make_client'>go_make_client</span><span class='lparen'>(</span><span class='rparen'>)</span>
  417.   <span class='kw'>return</span> <span class='id identifier rubyid_client_name'>client_name</span> <span class='kw'>if</span> <span class='id identifier rubyid_client_name'>client_name</span> <span class='comment'># Just return nil if you can&#39;t handle it
  418. </span><span class='kw'>end</span>
  419. </code></pre>
  420.  
  421.  
  422.   </div>
  423. </div>
  424. <div class="tags">
  425.   
  426.  
  427. </div><table class="source_code">
  428.   <tr>
  429.     <td>
  430.       <pre class="lines">
  431.  
  432.  
  433. 40
  434. 41
  435. 42</pre>
  436.     </td>
  437.     <td>
  438.       <pre class="code"><span class="info file"># File 'lib/helix_sync/client_service.rb', line 40</span>
  439.  
  440. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_handle_create_client'>handle_create_client</span>
  441.   <span class='cvar'>@@handle_create_client</span>
  442. <span class='kw'>end</span></pre>
  443.     </td>
  444.   </tr>
  445. </table>
  446. </div>
  447.     
  448.   </div>
  449.  
  450.   <div id="instance_method_details" class="method_details_list">
  451.     <h2>Instance Method Details</h2>
  452.  
  453.     
  454.       <div class="method_details first">
  455.   <h3 class="signature first" id="create_client-instance_method">
  456.   
  457.     - (<tt>Object</tt>) <strong>create_client</strong>(project, device, root) 
  458.   
  459.  
  460.   
  461.  
  462.   
  463. </h3><div class="docstring">
  464.   <div class="discussion">
  465.     
  466. <p>Create a client for the project.</p>
  467.  
  468. <p>Returns the new client name if successful, nil otherwise.</p>
  469.  
  470.  
  471.   </div>
  472. </div>
  473. <div class="tags">
  474.   
  475.  
  476. </div><table class="source_code">
  477.   <tr>
  478.     <td>
  479.       <pre class="lines">
  480.  
  481.  
  482. 47
  483. 48
  484. 49
  485. 50
  486. 51
  487. 52
  488. 53
  489. 54
  490. 55</pre>
  491.     </td>
  492.     <td>
  493.       <pre class="code"><span class="info file"># File 'lib/helix_sync/client_service.rb', line 47</span>
  494.  
  495. <span class='kw'>def</span> <span class='id identifier rubyid_create_client'>create_client</span><span class='lparen'>(</span><span class='id identifier rubyid_project'>project</span><span class='comma'>,</span> <span class='id identifier rubyid_device'>device</span><span class='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='rparen'>)</span>
  496.   <span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>=</span> <span class='kw'>nil</span>
  497.   <span class='cvar'>@@handle_create_client</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_handler'>handler</span><span class='op'>|</span>
  498.     <span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='id identifier rubyid_handler'>handler</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_project'>project</span><span class='comma'>,</span> <span class='id identifier rubyid_device'>device</span><span class='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='comma'>,</span> <span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
  499.     <span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span> <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span>
  500.     <span class='id identifier rubyid_id'>id</span>
  501.   <span class='kw'>end</span>
  502.   <span class='id identifier rubyid_client_id'>client_id</span>
  503. <span class='kw'>end</span></pre>
  504.     </td>
  505.   </tr>
  506. </table>
  507. </div>
  508.     
  509.       <div class="method_details ">
  510.   <h3 class="signature " id="p4-instance_method">
  511.   
  512.     - (<tt>Object</tt>) <strong>p4</strong> 
  513.   
  514.  
  515.   
  516.  
  517.   
  518. </h3><table class="source_code">
  519.   <tr>
  520.     <td>
  521.       <pre class="lines">
  522.  
  523.  
  524. 57
  525. 58
  526. 59</pre>
  527.     </td>
  528.     <td>
  529.       <pre class="code"><span class="info file"># File 'lib/helix_sync/client_service.rb', line 57</span>
  530.  
  531. <span class='kw'>def</span> <span class='id identifier rubyid_p4'>p4</span>
  532.   <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>p4</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  533. <span class='kw'>end</span></pre>
  534.     </td>
  535.   </tr>
  536. </table>
  537. </div>
  538.     
  539.   </div>
  540.  
  541. </div>
  542.  
  543.     <div id="footer">
  544.   Generated on Tue Sep 15 01:20:30 2015 by
  545.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  546.   0.8.7.6 (ruby-2.2.3).
  547. </div>
  548.  
  549.   </body>
  550. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago