poanetwork
/
poa-netstats-agent
mirror of https://github.com/poanetwork/poa-netstats-agent.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
poa-netstats-agent/doc/api-reference.html

188 lines
5.5 KiB
HTML
Raw Normal View History

[#57] improving documentation
2018-07-06 13:59:27 -07:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.18.3">
<title>API Reference – poa_agent v0.1.0</title>
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
[#71] Adding Getting Started guide
2018-08-20 17:35:56 -07:00
<script src="dist/sidebar_items-303975f305.js"></script>
[#57] improving documentation
2018-07-06 13:59:27 -07:00
</head>
<body data-type="extras">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<button class="sidebar-button night-mode-toggle">
<span class="icon-theme" aria-hidden="true"></span>
<span class="sr-only">Toggle Theme</span>
</button>
<section class="sidebar">
[#71] Adding Getting Started guide
2018-08-20 17:35:56 -07:00
<a href="POAAgent.html" class="sidebar-projectLink">
[#57] improving documentation
2018-07-06 13:59:27 -07:00
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
poa_agent
</h1>
<h2 class="sidebar-projectVersion">
v0.1.0
</h2>
</div>
</a>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
</form>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">poa_agent v0.1.0</small>
API Reference
</h1>
<section class="details-list">
<h2 id="modules" class="section-heading">
<a href="#modules" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Modules
</h2>
<div class="summary">
<div class="summary-row">
[#71] Adding Getting Started guide
2018-08-20 17:35:56 -07:00
<div class="summary-signature"><a href="POAAgent.html">POAAgent</a></div>
<div class="summary-synopsis"><h1>POAAgent</h1>
</div>
</div>
<div class="summary-row">
[#57] improving documentation
2018-07-06 13:59:27 -07:00
<div class="summary-signature"><a href="POAAgent.Application.html">POAAgent.Application</a></div>
<div class="summary-synopsis"><p>This module implements the Application behaviour</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Entity.NameConvention.html">POAAgent.Entity.NameConvention</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Format.POAProtocol.Data.Format.html">POAAgent.Format.POAProtocol.Data.Format</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Plugins.Collector.html">POAAgent.Plugins.Collector</a></div>
<div class="summary-synopsis"><p>Defines a Collector Plugin</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Plugins.Collectors.Eth.Information.html">POAAgent.Plugins.Collectors.Eth.Information</a></div>
<div class="summary-synopsis"><p>This is a Collector’s Plugin which sends peridodically the Ethereum information to the transfer</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Plugins.Collectors.Eth.LatestBlock.html">POAAgent.Plugins.Collectors.Eth.LatestBlock</a></div>
<div class="summary-synopsis"><p>This is a Collector’s Plugin which makes requests to a Ethereum node in order to know if
a new block has been added</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Plugins.Collectors.Eth.Pending.html">POAAgent.Plugins.Collectors.Eth.Pending</a></div>
<div class="summary-synopsis"><p>This is a Collector’s Plugin which makes requests to a Ethereum node in order to know if
the “pending” has been changed</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Plugins.Collectors.Eth.Stats.html">POAAgent.Plugins.Collectors.Eth.Stats</a></div>
<div class="summary-synopsis"><p>This is a Collector’s Plugin which makes requests to a Ethereum node in order to know if
the stats has been changed</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Plugins.Transfer.html">POAAgent.Plugins.Transfer</a></div>
<div class="summary-synopsis"><p>Defines a Transfer Plugin</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="POAAgent.Plugins.Transfers.WebSocket.Primus.html">POAAgent.Plugins.Transfers.WebSocket.Primus</a></div>
</div>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.18.3),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-9bd040e5e5.js"></script>
</body>
</html>