diff options
Diffstat (limited to 'doc/Zero/Request/Client.html')
| -rw-r--r-- | doc/Zero/Request/Client.html | 579 |
1 files changed, 579 insertions, 0 deletions
diff --git a/doc/Zero/Request/Client.html b/doc/Zero/Request/Client.html new file mode 100644 index 0000000..f2e733d --- /dev/null +++ b/doc/Zero/Request/Client.html @@ -0,0 +1,579 @@ +<!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> + Class: Zero::Request::Client + + — Documentation by YARD 0.8.3 + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + hasFrames = window.top.frames.main ? true : false; + relpath = '../../'; + framesUrl = "../../frames.html#!" + escape(window.location.href); +</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 (C)</a> » + <span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> » <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span> + » + <span class="title">Client</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>Class: Zero::Request::Client + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Zero::Request::Client</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/zero/request/client.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>This class represents all information about the client of a request.</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="KEY_REMOTE_ADDR-constant" class="">KEY_REMOTE_ADDR = + <div class="docstring"> + <div class="discussion"> + +<p>the key for the ip of the client</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'REMOTE_ADDR'</span> +</pre></dd> + + <dt id="KEY_REMOTE_HOST-constant" class="">KEY_REMOTE_HOST = + <div class="docstring"> + <div class="discussion"> + +<p>the key for the hostname</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'REMOTE_HOST'</span> +</pre></dd> + + <dt id="KEY_USER_AGENT-constant" class="">KEY_USER_AGENT = + <div class="docstring"> + <div class="discussion"> + +<p>the key for the user agent</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'HTTP_USER_AGENT'</span> +</pre></dd> + + </dl> + + + + + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#address-instance_method" title="#address (instance method)">- (String) <strong>address</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>the ip address of the client.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#hostname-instance_method" title="#hostname (instance method)">- (String) <strong>hostname</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>the hostname of the client.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#user_agent-instance_method" title="#user_agent (instance method)">- (String) <strong>user_agent</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>the user agent of the client.</p> +</div></span> + +</li> + + + </ul> + + + + + + <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="#initialize-instance_method" title="#initialize (instance method)">- (Client) <strong>initialize</strong>(environment) </a> + + + + </span> + + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>creates a new client with the data of the request environment.</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <h3 class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Zero::Request::Client (class)">Client</a></span></tt>) <strong>initialize</strong>(environment) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>creates a new client with the data of the request environment</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>environment</span> + + + <span class='type'></span> + + + + — + <div class='inline'> +<p>a hash representation of the request</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +14 +15 +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 14</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span> + <span class='rubyid_@address ivar id'>@address</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_REMOTE_ADDR constant id'>KEY_REMOTE_ADDR</span><span class='rbrack token'>]</span> + <span class='rubyid_@hostname ivar id'>@hostname</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_REMOTE_HOST constant id'>KEY_REMOTE_HOST</span><span class='rbrack token'>]</span> + <span class='rubyid_@user_agent ivar id'>@user_agent</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_USER_AGENT constant id'>KEY_USER_AGENT</span><span class='rbrack token'>]</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <div class="method_details first"> + <h3 class="signature first" id="address-instance_method"> + + - (<tt>String</tt>) <strong>address</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>the ip address of the client</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 address of the client</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +22 +23 +24</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 22</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_address identifier id'>address</span> + <span class='rubyid_@address ivar id'>@address</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="hostname-instance_method"> + + - (<tt>String</tt>) <strong>hostname</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>the hostname of the client</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 hostname of the client</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/zero/request/client.rb', line 25</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_hostname identifier id'>hostname</span> + <span class='rubyid_@hostname ivar id'>@hostname</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="user_agent-instance_method"> + + - (<tt>String</tt>) <strong>user_agent</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>the user agent of the client</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 user agent of the client</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 28</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_user_agent identifier id'>user_agent</span> + <span class='rubyid_@user_agent ivar id'>@user_agent</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + +</div> + + <div id="footer"> + Generated on Mon Nov 26 21:40:01 2012 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.8.3 (ruby-1.9.3). +</div> + + </body> +</html>
\ No newline at end of file |