docs/DevDNSd/System.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: DevDNSd::System
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!DevDNSd/System.html";
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> »
<span class='title'><span class='object_link'><a href="../DevDNSd.html" title="DevDNSd (module)">DevDNSd</a></span></span>
»
<span class="title">System</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: DevDNSd::System
</h1>
<dl class="box">
<dt class="r1">Extended by:</dt>
<dd class="r1">ActiveSupport::Concern</dd>
<dt class="r2">Included in:</dt>
<dd class="r2"><span class='object_link'><a href="Application.html" title="DevDNSd::Application (class)">Application</a></span></dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/devdnsd/system.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>System management methods.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#action_restart-instance_method" title="#action_restart (instance method)">- (Boolean) <strong>action_restart</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Restarts the server in background.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#action_start-instance_method" title="#action_start (instance method)">- (Boolean) <strong>action_start</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Starts the server in background.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#action_status-instance_method" title="#action_status (instance method)">- (Boolean) <strong>action_status</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Shows the status of the server.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#action_stop-instance_method" title="#action_stop (instance method)">- (Boolean) <strong>action_stop</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Stops the server in background.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#daemon_name-instance_method" title="#daemon_name (instance method)">- (String) <strong>daemon_name</strong> </a>
(also: #name)
</span>
<span class="summary_desc"><div class='inline'><p>Returns the name of the daemon.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_directory-instance_method" title="#log_directory (instance method)">- (String) <strong>log_directory</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the standard location of the log file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_file_path-instance_method" title="#log_file_path (instance method)">- (String) <strong>log_file_path</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the complete path of the log file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process_file_path-instance_method" title="#process_file_path (instance method)">- (String) <strong>process_file_path</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the complete path of the PID file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#working_directory-instance_method" title="#working_directory (instance method)">- (String) <strong>working_directory</strong> </a>
(also: #runtime_directory)
</span>
<span class="summary_desc"><div class='inline'><p>Returns the standard location of the PID file.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="action_restart-instance_method">
- (<tt>Boolean</tt>) <strong>action_restart</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Restarts the server in background.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p><code>true</code> if action succeeded, <code>false</code> otherwise.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
74
75
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 74</span>
<span class='kw'>def</span> <span class='id identifier rubyid_action_restart'>action_restart</span>
<span class='id identifier rubyid_action_stop'>action_stop</span>
<span class='id identifier rubyid_action_start'>action_start</span>
<span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="action_start-instance_method">
- (<tt>Boolean</tt>) <strong>action_start</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Starts the server in background.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p><code>true</code> if action succeeded, <code>false</code> otherwise.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56
57
58
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_action_start'>action_start</span>
<span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span><span class='lparen'>(</span><span class='id identifier rubyid_i18n'>i18n</span><span class='period'>.</span><span class='id identifier rubyid_starting'>starting</span><span class='rparen'>)</span>
<span class='id identifier rubyid_prepare_start'>prepare_start</span>
<span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_foreground'>foreground</span> <span class='op'>?</span> <span class='id identifier rubyid_perform_server'>perform_server</span> <span class='op'>:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
<span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="action_status-instance_method">
- (<tt>Boolean</tt>) <strong>action_status</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Shows the status of the server</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p><code>true</code> if action succeeded, <code>false</code> otherwise.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
83
84
85
86
87
88</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 83</span>
<span class='kw'>def</span> <span class='id identifier rubyid_action_status'>action_status</span>
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span>
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='symbol'>:crashed</span> <span class='kw'>if</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='symbol'>:unknown</span> <span class='op'>&&</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_crashed?'>crashed?</span>
<span class='id identifier rubyid_log_status'>log_status</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_pid'>pid</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="action_stop-instance_method">
- (<tt>Boolean</tt>) <strong>action_stop</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Stops the server in background.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p><code>true</code> if action succeeded, <code>false</code> otherwise.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_action_stop'>action_stop</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
<span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="daemon_name-instance_method">
- (<tt>String</tt>) <strong>daemon_name</strong>
<span class="aliases">Also known as:
<span class="names"><span id='name-instance_method'>name</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the name of the daemon.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the daemon.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_daemon_name'>daemon_name</span>
<span class='id identifier rubyid_config'>config</span> <span class='op'>?</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_pid_file'>pid_file</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>.pid</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>devdnsd</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="log_directory-instance_method">
- (<tt>String</tt>) <strong>log_directory</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the standard location of the log file.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The standard location of the log file.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_log_directory'>log_directory</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_log_file'>log_file</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="log_file_path-instance_method">
- (<tt>String</tt>) <strong>log_file_path</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the complete path of the log file.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The complete path of the log file.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_log_file_path'>log_file_path</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_log_file'>log_file</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="process_file_path-instance_method">
- (<tt>String</tt>) <strong>process_file_path</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the complete path of the PID file.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The complete path of the PID file.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process_file_path'>process_file_path</span>
<span class='id identifier rubyid_config'>config</span> <span class='op'>?</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_pid_file'>pid_file</span> <span class='op'>:</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_pwd'>pwd</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>devdnsd.pid</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="working_directory-instance_method">
- (<tt>String</tt>) <strong>working_directory</strong>
<span class="aliases">Also known as:
<span class="names"><span id='runtime_directory-instance_method'>runtime_directory</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the standard location of the PID file.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The standard location of the PID file.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/devdnsd/system.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_working_directory'>working_directory</span>
<span class='id identifier rubyid_config'>config</span> <span class='op'>?</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_pid_file'>pid_file</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_pwd'>pwd</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Aug 18 15:49:57 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
</body>
</html>