| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title> |
| Class: Qpid::Proton::URL |
| |
| — Qpid Proton Ruby API |
| |
| </title> |
| |
| <link rel="stylesheet" href="../../css/style.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../../css/common.css" type="text/css" /> |
| |
| <script type="text/javascript"> |
| pathId = "Qpid::Proton::URL"; |
| relpath = '../../'; |
| </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 class="nav_wrap"> |
| <iframe id="nav" src="../../class_list.html?1"></iframe> |
| <div id="resizer"></div> |
| </div> |
| |
| <div id="main" tabindex="-1"> |
| <div id="header"> |
| <div id="menu"> |
| |
| <a href="../../_index.html">Index (U)</a> » |
| <span class='title'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span> » <span class='title'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span> |
| » |
| <span class="title">URL</span> |
| |
| </div> |
| |
| <div id="search"> |
| |
| <a class="full_list_link" id="class_list_link" |
| href="../../class_list.html"> |
| |
| <svg width="24" height="24"> |
| <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> |
| <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> |
| <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> |
| </svg> |
| </a> |
| |
| </div> |
| <div class="clear"></div> |
| </div> |
| |
| <div id="content"><h1>Class: Qpid::Proton::URL |
| |
| <span class="deprecated note title">Deprecated</span> |
| |
| </h1> |
| <div class="box_info"> |
| |
| <dl> |
| <dt>Inherits:</dt> |
| <dd> |
| <span class="inheritName">Object</span> |
| |
| <ul class="fullTree"> |
| <li>Object</li> |
| |
| <li class="next">Qpid::Proton::URL</li> |
| |
| </ul> |
| <a href="#" class="inheritanceTree">show all</a> |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl> |
| <dt>Defined in:</dt> |
| <dd>lib/core/url.rb</dd> |
| </dl> |
| |
| </div> |
| |
| <h2>Overview</h2><div class="docstring"> |
| <div class="discussion"> |
| <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'> |
| <p>use <span class='object_link'>URI</span> or String</p> |
| </div></div> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| |
| |
| |
| <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="#host-instance_method" title="#host (instance method)">#<strong>host</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| <span class="note title readonly">readonly</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#password-instance_method" title="#password (instance method)">#<strong>password</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| <span class="note title readonly">readonly</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| <span class="note title readonly">readonly</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#scheme-instance_method" title="#scheme (instance method)">#<strong>scheme</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| <span class="note title readonly">readonly</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#username-instance_method" title="#username (instance method)">#<strong>username</strong> </a> |
| |
| |
| |
| (also: #user) |
| |
| </span> |
| |
| |
| |
| |
| <span class="note title readonly">readonly</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></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)">#<strong>initialize</strong>(url = nil) ⇒ URL </a> |
| |
| |
| |
| </span> |
| |
| |
| <span class="note title constructor">constructor</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Parse a string, return a new URL.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#port-instance_method" title="#port (instance method)">#<strong>port</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#port=-instance_method" title="#port= (instance method)">#<strong>port=</strong>(port) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ String </a> |
| |
| |
| |
| (also: #to_str) |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Convert to string.</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"> |
| |
| #<strong>initialize</strong>(url = nil) ⇒ <tt><span class='object_link'><a href="" title="Qpid::Proton::URL (class)">URL</a></span></tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Parse a string, return a new URL</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| <p class="tag_title">Parameters:</p> |
| <ul class="param"> |
| |
| <li> |
| |
| <span class='name'>url</span> |
| |
| |
| <span class='type'>(<tt>#<span class='object_link'><a href="#to_s-instance_method" title="Qpid::Proton::URL#to_s (method)">to_s</a></span></tt>)</span> |
| |
| |
| <em class="default">(defaults to: <tt>nil</tt>)</em> |
| |
| |
| — |
| <div class='inline'> |
| <p>the URL string</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 34 |
| 35 |
| 36 |
| 37 |
| 38 |
| 39 |
| 40 |
| 41 |
| 42 |
| 43 |
| 44 |
| 45 |
| 46 |
| 47 |
| 48 |
| 49 |
| 50 |
| 51</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/url.rb', line 34</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_deprecated'>deprecated</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>URI or String</span><span class='tstring_end'>'</span></span> |
| <span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span> |
| <span class='ivar'>@url</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_parse'>pn_url_parse</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> |
| <span class='kw'>if</span> <span class='ivar'>@url</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> |
| <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>ArgumentError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>invalid url: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> |
| <span class='kw'>end</span> |
| <span class='kw'>else</span> |
| <span class='ivar'>@url</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url'>pn_url</span> |
| <span class='kw'>end</span> |
| <span class='ivar'>@scheme</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_get_scheme'>pn_url_get_scheme</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='rparen'>)</span> |
| <span class='ivar'>@username</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_get_username'>pn_url_get_username</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='rparen'>)</span> |
| <span class='ivar'>@password</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_get_password'>pn_url_get_password</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='rparen'>)</span> |
| <span class='ivar'>@host</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_get_host'>pn_url_get_host</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='rparen'>)</span> |
| <span class='ivar'>@port</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_get_port'>pn_url_get_port</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='rparen'>)</span> |
| <span class='ivar'>@path</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_get_path'>pn_url_get_path</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_defaults'>defaults</span> |
| <span class='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="host-instance_method"> |
| |
| #<strong>host</strong> <span class="extras">(readonly)</span> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 29 |
| 30 |
| 31</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/url.rb', line 29</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_host'>host</span> |
| <span class='ivar'>@host</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| <span id=""></span> |
| <div class="method_details "> |
| <h3 class="signature " id="password-instance_method"> |
| |
| #<strong>password</strong> <span class="extras">(readonly)</span> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </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/core/url.rb', line 28</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_password'>password</span> |
| <span class='ivar'>@password</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| <span id=""></span> |
| <div class="method_details "> |
| <h3 class="signature " id="path-instance_method"> |
| |
| #<strong>path</strong> <span class="extras">(readonly)</span> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 30 |
| 31 |
| 32</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/url.rb', line 30</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span> |
| <span class='ivar'>@path</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| <span id=""></span> |
| <div class="method_details "> |
| <h3 class="signature " id="scheme-instance_method"> |
| |
| #<strong>scheme</strong> <span class="extras">(readonly)</span> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </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/core/url.rb', line 25</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_scheme'>scheme</span> |
| <span class='ivar'>@scheme</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| <span id=""></span> |
| <div class="method_details "> |
| <h3 class="signature " id="username-instance_method"> |
| |
| #<strong>username</strong> <span class="extras">(readonly)</span> |
| |
| |
| |
| <span class="aliases">Also known as: |
| <span class="names"><span id='user-instance_method'>user</span></span> |
| </span> |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 26 |
| 27 |
| 28</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/url.rb', line 26</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_username'>username</span> |
| <span class='ivar'>@username</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| </div> |
| |
| |
| <div id="instance_method_details" class="method_details_list"> |
| <h2>Instance Method Details</h2> |
| |
| |
| <div class="method_details first"> |
| <h3 class="signature first" id="port-instance_method"> |
| |
| #<strong>port</strong> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 61 |
| 62 |
| 63</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/url.rb', line 61</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_port'>port</span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_get_port'>pn_url_get_port</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="port=-instance_method"> |
| |
| #<strong>port=</strong>(port) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 53 |
| 54 |
| 55 |
| 56 |
| 57 |
| 58 |
| 59</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/url.rb', line 53</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_port='>port=</span><span class='lparen'>(</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span> |
| <span class='kw'>if</span> <span class='id identifier rubyid_port'>port</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_set_port'>pn_url_set_port</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span> |
| <span class='kw'>else</span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_url_set_port'>pn_url_set_port</span><span class='lparen'>(</span><span class='ivar'>@url</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span> |
| <span class='kw'>end</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="to_s-instance_method"> |
| |
| #<strong>to_s</strong> ⇒ <tt>String</tt> |
| |
| |
| |
| <span class="aliases">Also known as: |
| <span class="names"><span id='to_str-instance_method'>to_str</span></span> |
| </span> |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns Convert to string.</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>Convert to string</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 66 |
| 67 |
| 68</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/url.rb', line 66</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> |
| <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@scheme</span><span class='embexpr_end'>}</span><span class='tstring_content'>://</span><span class='embexpr_beg'>#{</span><span class='ivar'>@username</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='ivar'>@username</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='ivar'>@password</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>@</span><span class='tstring_end'>'</span></span> <span class='op'>+</span> <span class='ivar'>@password</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:</span><span class='tstring_end'>'</span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='ivar'>@host</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='ivar'>@port</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div id="footer"> |
| Generated on Wed Nov 11 12:57:54 2020 by |
| <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> |
| 0.9.24 (ruby-2.7.2). |
| </div> |
| |
| </div> |
| </body> |
| </html> |
