191 lines
5.7 KiB
HTML
191 lines
5.7 KiB
HTML
|
<!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_backend v0.1.0</title>
|
|||
|
|
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
|||
|
|
|
|||
|
|
<script src="dist/sidebar_items-ffeb4f1e51.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</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">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="api-reference.html" class="sidebar-projectLink">
|
|||
|
|
<div class="sidebar-projectDetails">
|
|||
|
|
<h1 class="sidebar-projectName">
|
|||
|
|
poa_backend
|
|||
|
|
</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_backend 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">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.html">POABackend</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>Storage and data-processing companion for the <a href="https://github.com/poanetwork/poa-netstats-agent">poa-netstats-agent</a></p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.CustomHandler.html">POABackend.CustomHandler</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>A Custom Handler is responsible of handling data sent from Agents (i.e. REST over HTTP, WebSockets…) “speaking” the POA Protocol</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.CustomHandler.REST.html">POABackend.CustomHandler.REST</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>This module implements the REST Custom Handler over HTTP/1.1</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.Protocol.html">POABackend.Protocol</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><h2 id="poa-protocol" class="section-heading">
|
|||
|
|
<a href="#poa-protocol" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
|
|||
|
|
POA Protocol
|
|||
|
|
</h2>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.Protocol.DataType.html">POABackend.Protocol.DataType</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>The protocol messages Data type</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.Protocol.Message.html">POABackend.Protocol.Message</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>The message received from the Agent (inspired in <a href="https://hexdocs.pm/plug/Plug.Conn.html"><code class="inline">Plug.Conn</code></a>)</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.Protocol.MessageType.html">POABackend.Protocol.MessageType</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>Regarding the POA Protocol only 2 types of message can be processed in the backend</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.Receiver.html">POABackend.Receiver</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>Defines a Receiver Plugin</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.Receivers.Dashboard.html">POABackend.Receivers.Dashboard</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>This is a Receiver Plugin which exposes a Websocket server and sends the metrics to the connected clients</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="summary-row">
|
|||
|
|
<div class="summary-signature"><a href="POABackend.Receivers.DynamoDB.html">POABackend.Receivers.DynamoDB</a></div>
|
|||
|
|
|
|||
|
|
<div class="summary-synopsis"><p>This is a Receiver Plugin which stores the received Ethereum Blocks in DynamoDB</p>
|
|||
|
|
</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>
|
|||
|
|
|