<!DOCTYPE html>
<html lang='en'>
<head>
<meta charset='utf-8'>
<title>Nimiq::Client - RDoc Documentation</title>
<meta content='width=device-width, initial-scale=1, maximum-scale=1' name='viewport'>
<link href='../../css/bootstrap.min.css' media='screen' rel='stylesheet' type='text/css'>
<link href='../../css/application.css' media='screen' rel='stylesheet' type='text/css'>
<link href='../../css/coderay.css' media='screen' rel='stylesheet' type='text/css'>
<script src='../../js/jquery.js' type='text/javascript'></script>
<script src='../../js/bootstrap.min.js' type='text/javascript'></script>
<script src='../../js/index.js' type='text/javascript'></script>
<script src='../../js/application.js' type='text/javascript'></script>
</head>
<body class='class'>
<div class='navbar navbar-fixed-top'>
<div class='navbar-inner'>
<div class='container'>
<a class='btn btn-navbar' data-target='.nav-collapse' data-toggle='collapse'>
<span class='icon-bar'></span>
<span class='icon-bar'></span>
<span class='icon-bar'></span>
</a>
<a href="../.." class="brand">RDoc Documentation</a>
<div class='nav-collapse'>
<ul class='nav'>
<li class='dropdown'>
<a class='dropdown-toggle' data-toggle='dropdown' href='#'>
Classes
<b class='caret'></b>
</a>
<ul class='dropdown-menu' role='menu'>
<li><a href="../Api.html">Api</a></li><li><a href="../ClientRPC.html">ClientRPC</a></li><li><a href="../ClientRPC/Connect.html"><span class="parent">ClientRPC::</span>Connect</a></li><li><a href="../ClientRPC/Connect/Error.html"><span class="parent">ClientRPC::Connect::</span>Error</a></li><li><a href="../Nimiq.html">Nimiq</a></li><li><a href="Client.html"><span class="parent">Nimiq::</span>Client</a></li><li><a href="Error.html"><span class="parent">Nimiq::</span>Error</a></li><li><a href="Exceptions.html"><span class="parent">Nimiq::</span>Exceptions</a></li>
</ul>
</li>
<li class='dropdown'>
<a class='dropdown-toggle' data-toggle='dropdown' href='#'>
Files
<b class='caret'></b>
</a>
<ul class='dropdown-menu' role='menu'>
<li><a href="../../files/lib/api_rb.html">api.rb</a></li>
<li><a href="../../files/lib/client_rb.html">client.rb</a></li>
<li><a href="../../files/lib/rpcclient_rb.html">rpcclient.rb</a></li>
</ul>
</li>
</ul>
<form class='navbar-search pull-right'>
<input class='search-query span2' id='search-query' placeholder='Search methods' type='text'>
<ul aria-labelledby='search-query' class='dropdown-menu' id='search-results' role='menu'></ul>
</form>
</div>
</div>
</div>
</div>
<div id='main'>
<div class='container' id='documentation'>
<div class='row'>
<div class='span9'>
<div class='name'><span class='type'>class</span>
Nimiq::Client
</div>
<section id='content'>
<div id='text'>
<div id='description'>
<p>Document the responsibility of the class</p>
<h2 id="class-Nimiq::Client-label-Heading">Heading<span><a href="#class-Nimiq::Client-label-Heading">¶</a> <a href="#top">↑</a></span></h2>
<p>Use headings to break up descriptions</p>
<h2 id="class-Nimiq::Client-label-Formatting">Formatting<span><a href="#class-Nimiq::Client-label-Formatting">¶</a> <a href="#top">↑</a></span></h2>
<p>Embody <code>parameters</code> or <code>options</code> in Teletype Text tags. You can also use <strong>bold</strong> or <strong>italics</strong> but must use HTML tags for <strong>multiple words</strong>, <em>like this</em> and <code>like this</code>.</p>
</div>
<div id='context'>
<section id='includes'>
<h2>Included modules</h2>
<ol>
<li><a href="../Api.html">Api</a></li>
</ol>
</section>
</div>
<div id='section'>
<div id='methods'>
<article id='public class-methods'>
<h2>Public Class methods</h2>
<a name='method-c-new'></a>
<section class='method public-class' id='method-method-c-new'>
<h3 class='synopsis'>
<span class='name'>new</span>
<span class='arguments'>(opts)</span>
</h3>
<div class='description'>
</div>
<div class='source'>
<a class='btn btn-mini source-toggle collapsed' data-toggle='collapse' href='#method-c-new-source'>
<span class='show'>
<span class='icon-resize-full'></span>
Show
</span>
<span class='hide'>
<span class='icon-resize-small'></span>
Hide
</span>
Source
</a>
<div class='collapse' id='method-c-new-source'>
<div class="CodeRay">
<div class="code"><pre><span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">initialize</span>(opts)
<span style="color:#777"># self.Connect(opts)</span>
<span style="color:#080;font-weight:bold">return</span> <span style="color:#33B">@rpc</span> = <span style="color:#036;font-weight:bold">ClientRPC</span>::<span style="color:#036;font-weight:bold">Connect</span>.new(opts)
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Connecting to </span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span><span style="color:#33B">@opts</span><span style="font-weight:bold;color:#666">}</span></span><span style="color:#710">"</span></span>
<span style="color:#080;font-weight:bold">end</span></pre></div>
</div>
</div>
</div>
</section>
</article>
<article id='public instance-methods'>
<h2>Public Instance methods</h2>
<a name='method-i-ping'></a>
<section class='method public-instance' id='method-method-i-ping'>
<h3 class='synopsis'>
<span class='name'>ping</span>
<span class='arguments'>()</span>
</h3>
<div class='description'>
</div>
<div class='source'>
<a class='btn btn-mini source-toggle collapsed' data-toggle='collapse' href='#method-i-ping-source'>
<span class='show'>
<span class='icon-resize-full'></span>
Show
</span>
<span class='hide'>
<span class='icon-resize-small'></span>
Hide
</span>
Source
</a>
<div class='collapse' id='method-i-ping-source'>
<div class="CodeRay">
<div class="code"><pre><span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">ping</span>
<span style="color:#777"># @response = "pavsan"</span>
<span style="color:#33B">@rpc</span>.ping_node
<span style="color:#33B">@pingres</span> = <span style="color:#33B">@rpc</span>.instance_variable_get(<span style="color:#A60">:@pingres</span>)
<span style="color:#080;font-weight:bold">end</span></pre></div>
</div>
</div>
</div>
</section>
<a name='method-i-request'></a>
<section class='method public-instance' id='method-method-i-request'>
<h3 class='synopsis'>
<span class='name'>request</span>
<span class='arguments'>(name, params = nil)</span>
</h3>
<div class='description'>
</div>
<div class='source'>
<a class='btn btn-mini source-toggle collapsed' data-toggle='collapse' href='#method-i-request-source'>
<span class='show'>
<span class='icon-resize-full'></span>
Show
</span>
<span class='hide'>
<span class='icon-resize-small'></span>
Hide
</span>
Source
</a>
<div class='collapse' id='method-i-request-source'>
<div class="CodeRay">
<div class="code"><pre><span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">request</span>(name, params = <span style="color:#069">nil</span>)
<span style="color:#080;font-weight:bold">return</span> <span style="color:#33B">@rpc</span>.request(name, params)
<span style="color:#080;font-weight:bold">end</span></pre></div>
</div>
</div>
</div>
</section>
</article>
</div>
</div>
</div>
</section>
</div>
<div class='span3'>
<ul class='nav nav-list'>
<li class='nav-header'>Defined IN</li>
<li>
<a href="../../files/lib/client_rb.html">lib/client.rb</a>
</li>
<li class='nav-header'>Parent</li>
<li>
<strong>
<a href="../Nimiq.html">Nimiq</a>
</strong>
</li>
<li class='divider'></li>
<li class='nav-header'>Public Class</li>
<li><a href="#method-c-new">new</a></li>
<li class='nav-header'>Public Instance</li>
<li><a href="#method-i-ping">ping</a></li>
<li><a href="#method-i-request">request</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class='container'>
<p>
Generated by
<a href="https://github.com/rdoc/rdoc">RDoc 6.2.1</a>
.
</p>
<p>
Generated with the
<a href="http://github.com/ngs/hanna-bootstrap">Hanna Bootstrap RDoc Generator 0.0.5</a>
.
</p>
</div>
</footer>
</body>
</html>