mirror of
https://github.com/corda/corda.git
synced 2025-06-12 20:28:18 +00:00
Regen docsite
This commit is contained in:
Mike Hearn
16
docs/build/html/api/protocols/-fetch-attachments-protocol/-init-.html
vendored
Normal file
16
docs/build/html/api/protocols/-fetch-attachments-protocol/-init-.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchAttachmentsProtocol.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchAttachmentsProtocol</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">FetchAttachmentsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchAttachmentsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/requests">requests</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.FetchAttachmentsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
|
||||
attachments are saved to local storage automatically.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-attachments-protocol/-t-o-p-i-c.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-attachments-protocol/-t-o-p-i-c.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchAttachmentsProtocol.TOPIC - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchAttachmentsProtocol</a> / <a href=".">TOPIC</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC</h1>
|
||||
<a name="protocols.FetchAttachmentsProtocol.Companion$TOPIC"></a>
|
||||
<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">TOPIC</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-attachments-protocol/convert.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-attachments-protocol/convert.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchAttachmentsProtocol.convert - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchAttachmentsProtocol</a> / <a href=".">convert</a><br/>
|
||||
<br/>
|
||||
<h1>convert</h1>
|
||||
<a name="protocols.FetchAttachmentsProtocol$convert(kotlin.ByteArray)"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">fun </span><span class="identifier">convert</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchAttachmentsProtocol$convert(kotlin.ByteArray)/wire">wire</span><span class="symbol">:</span> <span class="identifier">ByteArray</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core/-attachment/index.html"><span class="identifier">Attachment</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
103
docs/build/html/api/protocols/-fetch-attachments-protocol/index.html
vendored
Normal file
103
docs/build/html/api/protocols/-fetch-attachments-protocol/index.html
vendored
Normal file
@ -0,0 +1,103 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchAttachmentsProtocol - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">FetchAttachmentsProtocol</a><br/>
|
||||
<br/>
|
||||
<h1>FetchAttachmentsProtocol</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">FetchAttachmentsProtocol</span> <span class="symbol">:</span> <a href="../-fetch-data-protocol/index.html"><span class="identifier">FetchDataProtocol</span></a><span class="symbol"><</span><a href="../../core/-attachment/index.html"><span class="identifier">Attachment</span></a><span class="symbol">,</span> <span class="identifier">ByteArray</span><span class="symbol">></span></code><br/>
|
||||
<p>Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
|
||||
attachments are saved to local storage automatically.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">FetchAttachmentsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchAttachmentsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/requests">requests</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.FetchAttachmentsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><p>Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
|
||||
attachments are saved to local storage automatically.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="query-topic.html">queryTopic</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">queryTopic</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fetch-data-protocol/other-side.html">otherSide</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">otherSide</span><span class="symbol">: </span><a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fetch-data-protocol/requests.html">requests</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">requests</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="convert.html">convert</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">convert</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchAttachmentsProtocol$convert(kotlin.ByteArray)/wire">wire</span><span class="symbol">:</span> <span class="identifier">ByteArray</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core/-attachment/index.html"><span class="identifier">Attachment</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="load.html">load</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">load</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchAttachmentsProtocol$load(core.crypto.SecureHash)/txid">txid</span><span class="symbol">:</span> <a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../core/-attachment/index.html"><span class="identifier">Attachment</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="maybe-write-to-disk.html">maybeWriteToDisk</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">maybeWriteToDisk</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchAttachmentsProtocol$maybeWriteToDisk(kotlin.collections.List((core.Attachment)))/downloaded">downloaded</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../core/-attachment/index.html"><span class="identifier">Attachment</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fetch-data-protocol/call.html">call</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-fetch-data-protocol/-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><p>This is where you fill out your business logic.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Companion Object Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c.html">TOPIC</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">TOPIC</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-fetch-attachments-protocol/load.html
vendored
Normal file
16
docs/build/html/api/protocols/-fetch-attachments-protocol/load.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchAttachmentsProtocol.load - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchAttachmentsProtocol</a> / <a href=".">load</a><br/>
|
||||
<br/>
|
||||
<h1>load</h1>
|
||||
<a name="protocols.FetchAttachmentsProtocol$load(core.crypto.SecureHash)"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">fun </span><span class="identifier">load</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchAttachmentsProtocol$load(core.crypto.SecureHash)/txid">txid</span><span class="symbol">:</span> <a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../core/-attachment/index.html"><span class="identifier">Attachment</span></a><span class="symbol">?</span></code><br/>
|
||||
Overrides <a href="../-fetch-data-protocol/load.html">FetchDataProtocol.load</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-attachments-protocol/maybe-write-to-disk.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-attachments-protocol/maybe-write-to-disk.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchAttachmentsProtocol.maybeWriteToDisk - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchAttachmentsProtocol</a> / <a href=".">maybeWriteToDisk</a><br/>
|
||||
<br/>
|
||||
<h1>maybeWriteToDisk</h1>
|
||||
<a name="protocols.FetchAttachmentsProtocol$maybeWriteToDisk(kotlin.collections.List((core.Attachment)))"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">fun </span><span class="identifier">maybeWriteToDisk</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchAttachmentsProtocol$maybeWriteToDisk(kotlin.collections.List((core.Attachment)))/downloaded">downloaded</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../core/-attachment/index.html"><span class="identifier">Attachment</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-fetch-attachments-protocol/query-topic.html
vendored
Normal file
16
docs/build/html/api/protocols/-fetch-attachments-protocol/query-topic.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchAttachmentsProtocol.queryTopic - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchAttachmentsProtocol</a> / <a href=".">queryTopic</a><br/>
|
||||
<br/>
|
||||
<h1>queryTopic</h1>
|
||||
<a name="protocols.FetchAttachmentsProtocol$queryTopic"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">val </span><span class="identifier">queryTopic</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
Overrides <a href="../-fetch-data-protocol/query-topic.html">FetchDataProtocol.queryTopic</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.BadAnswer.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">BadAnswer</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">BadAnswer</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
42
docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/index.html
vendored
Normal file
42
docs/build/html/api/protocols/-fetch-data-protocol/-bad-answer/index.html
vendored
Normal file
@ -0,0 +1,42 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.BadAnswer - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href=".">BadAnswer</a><br/>
|
||||
<br/>
|
||||
<h1>BadAnswer</h1>
|
||||
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">BadAnswer</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">BadAnswer</span><span class="symbol">(</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-downloaded-vs-requested-data-mismatch/index.html">DownloadedVsRequestedDataMismatch</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">DownloadedVsRequestedDataMismatch</span> <span class="symbol">:</span> <span class="identifier">BadAnswer</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-hash-not-found/index.html">HashNotFound</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">HashNotFound</span> <span class="symbol">:</span> <span class="identifier">BadAnswer</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.DownloadedVsRequestedDataMismatch.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">DownloadedVsRequestedDataMismatch</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">DownloadedVsRequestedDataMismatch</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol.DownloadedVsRequestedDataMismatch$<init>(core.crypto.SecureHash, core.crypto.SecureHash)/requested">requested</span><span class="symbol">:</span> <a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">, </span><span class="identifier" id="protocols.FetchDataProtocol.DownloadedVsRequestedDataMismatch$<init>(core.crypto.SecureHash, core.crypto.SecureHash)/got">got</span><span class="symbol">:</span> <a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.DownloadedVsRequestedDataMismatch.got - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">DownloadedVsRequestedDataMismatch</a> / <a href=".">got</a><br/>
|
||||
<br/>
|
||||
<h1>got</h1>
|
||||
<a name="protocols.FetchDataProtocol.DownloadedVsRequestedDataMismatch$got"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">got</span><span class="symbol">: </span><a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,42 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.DownloadedVsRequestedDataMismatch - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href=".">DownloadedVsRequestedDataMismatch</a><br/>
|
||||
<br/>
|
||||
<h1>DownloadedVsRequestedDataMismatch</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">DownloadedVsRequestedDataMismatch</span> <span class="symbol">:</span> <a href="../-bad-answer/index.html"><span class="identifier">BadAnswer</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">DownloadedVsRequestedDataMismatch</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol.DownloadedVsRequestedDataMismatch$<init>(core.crypto.SecureHash, core.crypto.SecureHash)/requested">requested</span><span class="symbol">:</span> <a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">, </span><span class="identifier" id="protocols.FetchDataProtocol.DownloadedVsRequestedDataMismatch$<init>(core.crypto.SecureHash, core.crypto.SecureHash)/got">got</span><span class="symbol">:</span> <a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="got.html">got</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">got</span><span class="symbol">: </span><a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="requested.html">requested</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">requested</span><span class="symbol">: </span><a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.DownloadedVsRequestedDataMismatch.requested - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">DownloadedVsRequestedDataMismatch</a> / <a href=".">requested</a><br/>
|
||||
<br/>
|
||||
<h1>requested</h1>
|
||||
<a name="protocols.FetchDataProtocol.DownloadedVsRequestedDataMismatch$requested"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">requested</span><span class="symbol">: </span><a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.HashNotFound.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">HashNotFound</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">HashNotFound</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol.HashNotFound$<init>(core.crypto.SecureHash)/requested">requested</span><span class="symbol">:</span> <a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/index.html
vendored
Normal file
36
docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/index.html
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.HashNotFound - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href=".">HashNotFound</a><br/>
|
||||
<br/>
|
||||
<h1>HashNotFound</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">HashNotFound</span> <span class="symbol">:</span> <a href="../-bad-answer/index.html"><span class="identifier">BadAnswer</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">HashNotFound</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol.HashNotFound$<init>(core.crypto.SecureHash)/requested">requested</span><span class="symbol">:</span> <a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="requested.html">requested</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">requested</span><span class="symbol">: </span><a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/requested.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/-hash-not-found/requested.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.HashNotFound.requested - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">HashNotFound</a> / <a href=".">requested</a><br/>
|
||||
<br/>
|
||||
<h1>requested</h1>
|
||||
<a name="protocols.FetchDataProtocol.HashNotFound$requested"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">requested</span><span class="symbol">: </span><a href="../../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
30
docs/build/html/api/protocols/-fetch-data-protocol/-init-.html
vendored
Normal file
30
docs/build/html/api/protocols/-fetch-data-protocol/-init-.html
vendored
Normal file
@ -0,0 +1,30 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchDataProtocol</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">FetchDataProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/requests">requests</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.FetchDataProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>An abstract protocol for fetching typed data from a remote peer.</p>
|
||||
<p>Given a set of hashes (IDs), either loads them from local disk or asks the remote peer to provide them.</p>
|
||||
<p>A malicious response in which the data provided by the remote peer does not hash to the requested hash results in
|
||||
<a href="-downloaded-vs-requested-data-mismatch/index.html">DownloadedVsRequestedDataMismatch</a> being thrown. If the remote peer doesnt have an entry, it results in a
|
||||
<a href="-hash-not-found/index.html">HashNotFound</a> exception being thrown.</p>
|
||||
<p>By default this class does not insert data into any local database, if you want to do that after missing items were
|
||||
fetched then override <a href="maybe-write-to-disk.html">maybeWriteToDisk</a>. You <emph>must</emph> override <a href="load.html">load</a> and <a href="query-topic.html">queryTopic</a>. If the wire type is not the
|
||||
same as the ultimate type, you must also override <a href="convert.html">convert</a>.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Parameters</h3>
|
||||
<a name="T"></a>
|
||||
<code>T</code> - The ultimate type of the data being fetched.<br/>
|
||||
<br/>
|
||||
<a name="W"></a>
|
||||
<code>W</code> - The wire type of the data being fetched, for when it isnt the same as the ultimate type.<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-fetch-data-protocol/-result/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-fetch-data-protocol/-result/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.Result.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">Result</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Result</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol.Result$<init>(kotlin.collections.List((protocols.FetchDataProtocol.Result.T)), kotlin.collections.List((protocols.FetchDataProtocol.Result.T)))/fromDisk">fromDisk</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.FetchDataProtocol.Result$<init>(kotlin.collections.List((protocols.FetchDataProtocol.Result.T)), kotlin.collections.List((protocols.FetchDataProtocol.Result.T)))/downloaded">downloaded</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/-result/downloaded.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/-result/downloaded.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.Result.downloaded - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">Result</a> / <a href=".">downloaded</a><br/>
|
||||
<br/>
|
||||
<h1>downloaded</h1>
|
||||
<a name="protocols.FetchDataProtocol.Result$downloaded"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">downloaded</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/-result/from-disk.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/-result/from-disk.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.Result.fromDisk - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href="index.html">Result</a> / <a href=".">fromDisk</a><br/>
|
||||
<br/>
|
||||
<h1>fromDisk</h1>
|
||||
<a name="protocols.FetchDataProtocol.Result$fromDisk"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">fromDisk</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
42
docs/build/html/api/protocols/-fetch-data-protocol/-result/index.html
vendored
Normal file
42
docs/build/html/api/protocols/-fetch-data-protocol/-result/index.html
vendored
Normal file
@ -0,0 +1,42 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.Result - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">FetchDataProtocol</a> / <a href=".">Result</a><br/>
|
||||
<br/>
|
||||
<h1>Result</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Result</span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../../core/-named-by-hash/index.html"><span class="identifier">NamedByHash</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Result</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol.Result$<init>(kotlin.collections.List((protocols.FetchDataProtocol.Result.T)), kotlin.collections.List((protocols.FetchDataProtocol.Result.T)))/fromDisk">fromDisk</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.FetchDataProtocol.Result$<init>(kotlin.collections.List((protocols.FetchDataProtocol.Result.T)), kotlin.collections.List((protocols.FetchDataProtocol.Result.T)))/downloaded">downloaded</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="downloaded.html">downloaded</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">downloaded</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="from-disk.html">fromDisk</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">fromDisk</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-fetch-data-protocol/call.html
vendored
Normal file
17
docs/build/html/api/protocols/-fetch-data-protocol/call.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.call - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchDataProtocol</a> / <a href=".">call</a><br/>
|
||||
<br/>
|
||||
<h1>call</h1>
|
||||
<a name="protocols.FetchDataProtocol$call()"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../core.protocols/-protocol-logic/call.html">ProtocolLogic.call</a><br/>
|
||||
<p>This is where you fill out your business logic.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/convert.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/convert.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.convert - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchDataProtocol</a> / <a href=".">convert</a><br/>
|
||||
<br/>
|
||||
<h1>convert</h1>
|
||||
<a name="protocols.FetchDataProtocol$convert(protocols.FetchDataProtocol.W)"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">convert</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol$convert(protocols.FetchDataProtocol.W)/wire">wire</span><span class="symbol">:</span> <span class="identifier">W</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">T</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
216
docs/build/html/api/protocols/-fetch-data-protocol/index.html
vendored
Normal file
216
docs/build/html/api/protocols/-fetch-data-protocol/index.html
vendored
Normal file
@ -0,0 +1,216 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">FetchDataProtocol</a><br/>
|
||||
<br/>
|
||||
<h1>FetchDataProtocol</h1>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">FetchDataProtocol</span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../core/-named-by-hash/index.html"><span class="identifier">NamedByHash</span></a><span class="symbol">, </span><span class="identifier">W</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><a href="-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<p>An abstract protocol for fetching typed data from a remote peer.</p>
|
||||
<p>Given a set of hashes (IDs), either loads them from local disk or asks the remote peer to provide them.</p>
|
||||
<p>A malicious response in which the data provided by the remote peer does not hash to the requested hash results in
|
||||
<a href="-downloaded-vs-requested-data-mismatch/index.html">DownloadedVsRequestedDataMismatch</a> being thrown. If the remote peer doesnt have an entry, it results in a
|
||||
<a href="-hash-not-found/index.html">HashNotFound</a> exception being thrown.</p>
|
||||
<p>By default this class does not insert data into any local database, if you want to do that after missing items were
|
||||
fetched then override <a href="maybe-write-to-disk.html">maybeWriteToDisk</a>. You <emph>must</emph> override <a href="load.html">load</a> and <a href="query-topic.html">queryTopic</a>. If the wire type is not the
|
||||
same as the ultimate type, you must also override <a href="convert.html">convert</a>.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Parameters</h3>
|
||||
<a name="T"></a>
|
||||
<code>T</code> - The ultimate type of the data being fetched.<br/>
|
||||
<br/>
|
||||
<a name="W"></a>
|
||||
<code>W</code> - The wire type of the data being fetched, for when it isnt the same as the ultimate type.<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-result/index.html">Result</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Result</span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../core/-named-by-hash/index.html"><span class="identifier">NamedByHash</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Exceptions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-bad-answer/index.html">BadAnswer</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">BadAnswer</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-downloaded-vs-requested-data-mismatch/index.html">DownloadedVsRequestedDataMismatch</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">DownloadedVsRequestedDataMismatch</span> <span class="symbol">:</span> <a href="-bad-answer/index.html"><span class="identifier">BadAnswer</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-hash-not-found/index.html">HashNotFound</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">HashNotFound</span> <span class="symbol">:</span> <a href="-bad-answer/index.html"><span class="identifier">BadAnswer</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">FetchDataProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/requests">requests</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.FetchDataProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><p>An abstract protocol for fetching typed data from a remote peer.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="other-side.html">otherSide</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">otherSide</span><span class="symbol">: </span><a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="query-topic.html">queryTopic</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">queryTopic</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="requests.html">requests</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">requests</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/logger.html">logger</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">logger</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>This is where you should log things to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/progress-tracker.html">progressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a><span class="symbol">?</span></code><p>Override this to provide a <a href="../../core.utilities/-progress-tracker/index.html">ProgressTracker</a>. If one is provided and stepped, the framework will do something
|
||||
helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
|
||||
tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
|
||||
progress.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/psm.html">psm</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">lateinit</span> <span class="keyword">var </span><span class="identifier">psm</span><span class="symbol">: </span><a href="../../core.protocols/-protocol-state-machine/index.html"><span class="identifier">ProtocolStateMachine</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span></code><p>Reference to the <a href="#">Fiber</a> instance that is the top level controller for the entire flow.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/service-hub.html">serviceHub</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">serviceHub</span><span class="symbol">: </span><a href="../../core.node.services/-service-hub/index.html"><span class="identifier">ServiceHub</span></a></code><p>Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="call.html">call</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><p>This is where you fill out your business logic.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="convert.html">convert</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">convert</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol$convert(protocols.FetchDataProtocol.W)/wire">wire</span><span class="symbol">:</span> <span class="identifier">W</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">T</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="load.html">load</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">load</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol$load(core.crypto.SecureHash)/txid">txid</span><span class="symbol">:</span> <a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">T</span><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="maybe-write-to-disk.html">maybeWriteToDisk</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">maybeWriteToDisk</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol$maybeWriteToDisk(kotlin.collections.List((protocols.FetchDataProtocol.T)))/downloaded">downloaded</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/receive.html">receive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">receive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/send.html">send</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">send</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/send-and-receive.html">sendAndReceive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">sendAndReceive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForSend">sessionIDForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/sub-protocol.html">subProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span> <span class="identifier">subProtocol</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$subProtocol(core.protocols.ProtocolLogic((core.protocols.ProtocolLogic.subProtocol.R)))/subLogic">subLogic</span><span class="symbol">:</span> <a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">R</span></code><p>Invokes the given subprotocol by simply passing through this <a href="../../core.protocols/-protocol-logic/index.html">ProtocolLogic</a>s reference to the
|
||||
<a href="../../core.protocols/-protocol-state-machine/index.html">ProtocolStateMachine</a> and then calling the <a href="../../core.protocols/-protocol-logic/call.html">call</a> method.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fetch-attachments-protocol/index.html">FetchAttachmentsProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">FetchAttachmentsProtocol</span> <span class="symbol">:</span> <span class="identifier">FetchDataProtocol</span><span class="symbol"><</span><a href="../../core/-attachment/index.html"><span class="identifier">Attachment</span></a><span class="symbol">,</span> <span class="identifier">ByteArray</span><span class="symbol">></span></code><p>Given a set of hashes either loads from from local storage or requests them from the other peer. Downloaded
|
||||
attachments are saved to local storage automatically.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fetch-transactions-protocol/index.html">FetchTransactionsProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">FetchTransactionsProtocol</span> <span class="symbol">:</span> <span class="identifier">FetchDataProtocol</span><span class="symbol"><</span><a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">,</span> <a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">></span></code><p>Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/load.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/load.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.load - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchDataProtocol</a> / <a href=".">load</a><br/>
|
||||
<br/>
|
||||
<h1>load</h1>
|
||||
<a name="protocols.FetchDataProtocol$load(core.crypto.SecureHash)"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">load</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol$load(core.crypto.SecureHash)/txid">txid</span><span class="symbol">:</span> <a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">T</span><span class="symbol">?</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/maybe-write-to-disk.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/maybe-write-to-disk.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.maybeWriteToDisk - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchDataProtocol</a> / <a href=".">maybeWriteToDisk</a><br/>
|
||||
<br/>
|
||||
<h1>maybeWriteToDisk</h1>
|
||||
<a name="protocols.FetchDataProtocol$maybeWriteToDisk(kotlin.collections.List((protocols.FetchDataProtocol.T)))"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">maybeWriteToDisk</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchDataProtocol$maybeWriteToDisk(kotlin.collections.List((protocols.FetchDataProtocol.T)))/downloaded">downloaded</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/other-side.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/other-side.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.otherSide - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchDataProtocol</a> / <a href=".">otherSide</a><br/>
|
||||
<br/>
|
||||
<h1>otherSide</h1>
|
||||
<a name="protocols.FetchDataProtocol$otherSide"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">val </span><span class="identifier">otherSide</span><span class="symbol">: </span><a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/query-topic.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/query-topic.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.queryTopic - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchDataProtocol</a> / <a href=".">queryTopic</a><br/>
|
||||
<br/>
|
||||
<h1>queryTopic</h1>
|
||||
<a name="protocols.FetchDataProtocol$queryTopic"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">queryTopic</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-data-protocol/requests.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-data-protocol/requests.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchDataProtocol.requests - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchDataProtocol</a> / <a href=".">requests</a><br/>
|
||||
<br/>
|
||||
<h1>requests</h1>
|
||||
<a name="protocols.FetchDataProtocol$requests"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">val </span><span class="identifier">requests</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
21
docs/build/html/api/protocols/-fetch-transactions-protocol/-init-.html
vendored
Normal file
21
docs/build/html/api/protocols/-fetch-transactions-protocol/-init-.html
vendored
Normal file
@ -0,0 +1,21 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchTransactionsProtocol.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchTransactionsProtocol</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">FetchTransactionsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchTransactionsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/requests">requests</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.FetchTransactionsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.</p>
|
||||
<p>A malicious response in which the data provided by the remote peer does not hash to the requested hash results in
|
||||
<a href="../-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/index.html">FetchDataProtocol.DownloadedVsRequestedDataMismatch</a> being thrown. If the remote peer doesnt have an entry, it
|
||||
results in a <a href="../-fetch-data-protocol/-hash-not-found/index.html">FetchDataProtocol.HashNotFound</a> exception. Note that returned transactions are not inserted into
|
||||
the database, because its up to the caller to actually verify the transactions are valid.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-fetch-transactions-protocol/-t-o-p-i-c.html
vendored
Normal file
15
docs/build/html/api/protocols/-fetch-transactions-protocol/-t-o-p-i-c.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchTransactionsProtocol.TOPIC - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchTransactionsProtocol</a> / <a href=".">TOPIC</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC</h1>
|
||||
<a name="protocols.FetchTransactionsProtocol.Companion$TOPIC"></a>
|
||||
<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">TOPIC</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
95
docs/build/html/api/protocols/-fetch-transactions-protocol/index.html
vendored
Normal file
95
docs/build/html/api/protocols/-fetch-transactions-protocol/index.html
vendored
Normal file
@ -0,0 +1,95 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchTransactionsProtocol - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">FetchTransactionsProtocol</a><br/>
|
||||
<br/>
|
||||
<h1>FetchTransactionsProtocol</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">FetchTransactionsProtocol</span> <span class="symbol">:</span> <a href="../-fetch-data-protocol/index.html"><span class="identifier">FetchDataProtocol</span></a><span class="symbol"><</span><a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">,</span> <a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">></span></code><br/>
|
||||
<p>Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.</p>
|
||||
<p>A malicious response in which the data provided by the remote peer does not hash to the requested hash results in
|
||||
<a href="../-fetch-data-protocol/-downloaded-vs-requested-data-mismatch/index.html">FetchDataProtocol.DownloadedVsRequestedDataMismatch</a> being thrown. If the remote peer doesnt have an entry, it
|
||||
results in a <a href="../-fetch-data-protocol/-hash-not-found/index.html">FetchDataProtocol.HashNotFound</a> exception. Note that returned transactions are not inserted into
|
||||
the database, because its up to the caller to actually verify the transactions are valid.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">FetchTransactionsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchTransactionsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/requests">requests</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.FetchTransactionsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><p>Given a set of tx hashes (IDs), either loads them from local disk or asks the remote peer to provide them.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="query-topic.html">queryTopic</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">queryTopic</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fetch-data-protocol/other-side.html">otherSide</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">otherSide</span><span class="symbol">: </span><a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fetch-data-protocol/requests.html">requests</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">requests</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="load.html">load</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">load</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchTransactionsProtocol$load(core.crypto.SecureHash)/txid">txid</span><span class="symbol">:</span> <a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fetch-data-protocol/call.html">call</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-fetch-data-protocol/-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><p>This is where you fill out your business logic.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Companion Object Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c.html">TOPIC</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">TOPIC</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-fetch-transactions-protocol/load.html
vendored
Normal file
16
docs/build/html/api/protocols/-fetch-transactions-protocol/load.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchTransactionsProtocol.load - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchTransactionsProtocol</a> / <a href=".">load</a><br/>
|
||||
<br/>
|
||||
<h1>load</h1>
|
||||
<a name="protocols.FetchTransactionsProtocol$load(core.crypto.SecureHash)"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">fun </span><span class="identifier">load</span><span class="symbol">(</span><span class="identifier" id="protocols.FetchTransactionsProtocol$load(core.crypto.SecureHash)/txid">txid</span><span class="symbol">:</span> <a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">?</span></code><br/>
|
||||
Overrides <a href="../-fetch-data-protocol/load.html">FetchDataProtocol.load</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-fetch-transactions-protocol/query-topic.html
vendored
Normal file
16
docs/build/html/api/protocols/-fetch-transactions-protocol/query-topic.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>FetchTransactionsProtocol.queryTopic - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">FetchTransactionsProtocol</a> / <a href=".">queryTopic</a><br/>
|
||||
<br/>
|
||||
<h1>queryTopic</h1>
|
||||
<a name="protocols.FetchTransactionsProtocol$queryTopic"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">val </span><span class="identifier">queryTopic</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
Overrides <a href="../-fetch-data-protocol/query-topic.html">FetchDataProtocol.queryTopic</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-rates-fix-protocol/-fix-out-of-range/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-rates-fix-protocol/-fix-out-of-range/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.FixOutOfRange.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">FixOutOfRange</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">FixOutOfRange</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol.FixOutOfRange$<init>(java.math.BigDecimal)/byAmount">byAmount</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigDecimal.html"><span class="identifier">BigDecimal</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-fix-out-of-range/by-amount.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-fix-out-of-range/by-amount.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.FixOutOfRange.byAmount - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">FixOutOfRange</a> / <a href=".">byAmount</a><br/>
|
||||
<br/>
|
||||
<h1>byAmount</h1>
|
||||
<a name="protocols.RatesFixProtocol.FixOutOfRange$byAmount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">byAmount</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigDecimal.html"><span class="identifier">BigDecimal</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
docs/build/html/api/protocols/-rates-fix-protocol/-fix-out-of-range/index.html
vendored
Normal file
36
docs/build/html/api/protocols/-rates-fix-protocol/-fix-out-of-range/index.html
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.FixOutOfRange - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href=".">FixOutOfRange</a><br/>
|
||||
<br/>
|
||||
<h1>FixOutOfRange</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">FixOutOfRange</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">FixOutOfRange</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol.FixOutOfRange$<init>(java.math.BigDecimal)/byAmount">byAmount</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigDecimal.html"><span class="identifier">BigDecimal</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="by-amount.html">byAmount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">byAmount</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigDecimal.html"><span class="identifier">BigDecimal</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
21
docs/build/html/api/protocols/-rates-fix-protocol/-init-.html
vendored
Normal file
21
docs/build/html/api/protocols/-rates-fix-protocol/-init-.html
vendored
Normal file
@ -0,0 +1,21 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">RatesFixProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/tx">tx</span><span class="symbol">:</span> <a href="../../core/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/oracle">oracle</span><span class="symbol">:</span> <a href="../../core.messaging/-legally-identifiable-node/index.html"><span class="identifier">LegallyIdentifiableNode</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/fixOf">fixOf</span><span class="symbol">:</span> <a href="../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/expectedRate">expectedRate</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigDecimal.html"><span class="identifier">BigDecimal</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/rateTolerance">rateTolerance</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigDecimal.html"><span class="identifier">BigDecimal</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
|
||||
fix in the transaction and then proceeds to get the oracle to sign it. Although the <a href="call.html">call</a> method combines the query
|
||||
and signing step, you can run the steps individually by constructing this object and then using the public methods
|
||||
for each step.</p>
|
||||
<h3>Exceptions</h3>
|
||||
<a name="FixOutOfRange"></a>
|
||||
<code>FixOutOfRange</code> - if the returned fix was further away from the expected rate by the given amount.<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.QUERYING.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">QUERYING</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">QUERYING</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol.Companion.QUERYING$<init>(kotlin.String)/name">name</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
53
docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/index.html
vendored
Normal file
53
docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/index.html
vendored
Normal file
@ -0,0 +1,53 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.QUERYING - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href=".">QUERYING</a><br/>
|
||||
<br/>
|
||||
<h1>QUERYING</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">QUERYING</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">QUERYING</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol.Companion.QUERYING$<init>(kotlin.String)/name">name</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="name.html">name</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">name</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/changes.html">changes</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">changes</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/label.html">label</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">label</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/name.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-q-u-e-r-y-i-n-g/name.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.QUERYING.name - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">QUERYING</a> / <a href=".">name</a><br/>
|
||||
<br/>
|
||||
<h1>name</h1>
|
||||
<a name="protocols.RatesFixProtocol.Companion.QUERYING$name"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">name</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.QueryRequest.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">QueryRequest</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">QueryRequest</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol.QueryRequest$<init>(kotlin.collections.List((core.FixOf)), core.messaging.SingleMessageRecipient, kotlin.Long)/queries">queries</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol.QueryRequest$<init>(kotlin.collections.List((core.FixOf)), core.messaging.SingleMessageRecipient, kotlin.Long)/replyTo">replyTo</span><span class="symbol">:</span> <a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol.QueryRequest$<init>(kotlin.collections.List((core.FixOf)), core.messaging.SingleMessageRecipient, kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/index.html
vendored
Normal file
48
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/index.html
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.QueryRequest - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href=".">QueryRequest</a><br/>
|
||||
<br/>
|
||||
<h1>QueryRequest</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">QueryRequest</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">QueryRequest</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol.QueryRequest$<init>(kotlin.collections.List((core.FixOf)), core.messaging.SingleMessageRecipient, kotlin.Long)/queries">queries</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol.QueryRequest$<init>(kotlin.collections.List((core.FixOf)), core.messaging.SingleMessageRecipient, kotlin.Long)/replyTo">replyTo</span><span class="symbol">:</span> <a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol.QueryRequest$<init>(kotlin.collections.List((core.FixOf)), core.messaging.SingleMessageRecipient, kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="queries.html">queries</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">queries</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="reply-to.html">replyTo</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyTo</span><span class="symbol">: </span><a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="session-i-d.html">sessionID</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionID</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/queries.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/queries.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.QueryRequest.queries - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">QueryRequest</a> / <a href=".">queries</a><br/>
|
||||
<br/>
|
||||
<h1>queries</h1>
|
||||
<a name="protocols.RatesFixProtocol.QueryRequest$queries"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">queries</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/reply-to.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/reply-to.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.QueryRequest.replyTo - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">QueryRequest</a> / <a href=".">replyTo</a><br/>
|
||||
<br/>
|
||||
<h1>replyTo</h1>
|
||||
<a name="protocols.RatesFixProtocol.QueryRequest$replyTo"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyTo</span><span class="symbol">: </span><a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/session-i-d.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/session-i-d.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.QueryRequest.sessionID - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">QueryRequest</a> / <a href=".">sessionID</a><br/>
|
||||
<br/>
|
||||
<h1>sessionID</h1>
|
||||
<a name="protocols.RatesFixProtocol.QueryRequest$sessionID"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionID</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
31
docs/build/html/api/protocols/-rates-fix-protocol/-s-i-g-n-i-n-g.html
vendored
Normal file
31
docs/build/html/api/protocols/-rates-fix-protocol/-s-i-g-n-i-n-g.html
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.SIGNING - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">SIGNING</a><br/>
|
||||
<br/>
|
||||
<h1>SIGNING</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">SIGNING</span> <span class="symbol">:</span> <a href="../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.utilities/-progress-tracker/-step/changes.html">changes</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">changes</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.utilities/-progress-tracker/-step/label.html">label</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">label</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.SignRequest.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">SignRequest</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">SignRequest</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol.SignRequest$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient, kotlin.Long)/tx">tx</span><span class="symbol">:</span> <a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol.SignRequest$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient, kotlin.Long)/replyTo">replyTo</span><span class="symbol">:</span> <a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol.SignRequest$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient, kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/index.html
vendored
Normal file
48
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/index.html
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.SignRequest - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href=".">SignRequest</a><br/>
|
||||
<br/>
|
||||
<h1>SignRequest</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">SignRequest</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">SignRequest</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol.SignRequest$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient, kotlin.Long)/tx">tx</span><span class="symbol">:</span> <a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol.SignRequest$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient, kotlin.Long)/replyTo">replyTo</span><span class="symbol">:</span> <a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol.SignRequest$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient, kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="reply-to.html">replyTo</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyTo</span><span class="symbol">: </span><a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="session-i-d.html">sessionID</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionID</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="tx.html">tx</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">tx</span><span class="symbol">: </span><a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/reply-to.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/reply-to.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.SignRequest.replyTo - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">SignRequest</a> / <a href=".">replyTo</a><br/>
|
||||
<br/>
|
||||
<h1>replyTo</h1>
|
||||
<a name="protocols.RatesFixProtocol.SignRequest$replyTo"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyTo</span><span class="symbol">: </span><a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/session-i-d.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/session-i-d.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.SignRequest.sessionID - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">SignRequest</a> / <a href=".">sessionID</a><br/>
|
||||
<br/>
|
||||
<h1>sessionID</h1>
|
||||
<a name="protocols.RatesFixProtocol.SignRequest$sessionID"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionID</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/tx.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-sign-request/tx.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.SignRequest.tx - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">RatesFixProtocol</a> / <a href="index.html">SignRequest</a> / <a href=".">tx</a><br/>
|
||||
<br/>
|
||||
<h1>tx</h1>
|
||||
<a name="protocols.RatesFixProtocol.SignRequest$tx"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">tx</span><span class="symbol">: </span><a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/-t-o-p-i-c.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/-t-o-p-i-c.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.TOPIC - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">TOPIC</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC</h1>
|
||||
<a name="protocols.RatesFixProtocol.Companion$TOPIC"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
31
docs/build/html/api/protocols/-rates-fix-protocol/-w-o-r-k-i-n-g.html
vendored
Normal file
31
docs/build/html/api/protocols/-rates-fix-protocol/-w-o-r-k-i-n-g.html
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.WORKING - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">WORKING</a><br/>
|
||||
<br/>
|
||||
<h1>WORKING</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">WORKING</span> <span class="symbol">:</span> <a href="../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.utilities/-progress-tracker/-step/changes.html">changes</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">changes</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.utilities/-progress-tracker/-step/label.html">label</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">label</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-rates-fix-protocol/before-signing.html
vendored
Normal file
17
docs/build/html/api/protocols/-rates-fix-protocol/before-signing.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.beforeSigning - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">beforeSigning</a><br/>
|
||||
<br/>
|
||||
<h1>beforeSigning</h1>
|
||||
<a name="protocols.RatesFixProtocol$beforeSigning(core.Fix)"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">beforeSigning</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol$beforeSigning(core.Fix)/fix">fix</span><span class="symbol">:</span> <a href="../../core/-fix/index.html"><span class="identifier">Fix</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<p>You can override this to perform any additional work needed after the fix is added to the transaction but
|
||||
before its sent back to the oracle for signing (for example, adding output states that depend on the fix).</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-rates-fix-protocol/call.html
vendored
Normal file
17
docs/build/html/api/protocols/-rates-fix-protocol/call.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.call - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">call</a><br/>
|
||||
<br/>
|
||||
<h1>call</h1>
|
||||
<a name="protocols.RatesFixProtocol$call()"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
Overrides <a href="../../core.protocols/-protocol-logic/call.html">ProtocolLogic.call</a><br/>
|
||||
<p>This is where you fill out your business logic.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
203
docs/build/html/api/protocols/-rates-fix-protocol/index.html
vendored
Normal file
203
docs/build/html/api/protocols/-rates-fix-protocol/index.html
vendored
Normal file
@ -0,0 +1,203 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">RatesFixProtocol</a><br/>
|
||||
<br/>
|
||||
<h1>RatesFixProtocol</h1>
|
||||
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">RatesFixProtocol</span> <span class="symbol">:</span> <a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><span class="identifier">Unit</span><span class="symbol">></span></code><br/>
|
||||
<p>This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
|
||||
fix in the transaction and then proceeds to get the oracle to sign it. Although the <a href="call.html">call</a> method combines the query
|
||||
and signing step, you can run the steps individually by constructing this object and then using the public methods
|
||||
for each step.</p>
|
||||
<h3>Exceptions</h3>
|
||||
<a name="FixOutOfRange"></a>
|
||||
<code>FixOutOfRange</code> - if the returned fix was further away from the expected rate by the given amount.<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-q-u-e-r-y-i-n-g/index.html">QUERYING</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">QUERYING</span> <span class="symbol">:</span> <a href="../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-query-request/index.html">QueryRequest</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">QueryRequest</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-s-i-g-n-i-n-g.html">SIGNING</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">SIGNING</span> <span class="symbol">:</span> <a href="../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-sign-request/index.html">SignRequest</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">SignRequest</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-w-o-r-k-i-n-g.html">WORKING</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">WORKING</span> <span class="symbol">:</span> <a href="../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Exceptions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-fix-out-of-range/index.html">FixOutOfRange</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">FixOutOfRange</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">RatesFixProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/tx">tx</span><span class="symbol">:</span> <a href="../../core/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/oracle">oracle</span><span class="symbol">:</span> <a href="../../core.messaging/-legally-identifiable-node/index.html"><span class="identifier">LegallyIdentifiableNode</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/fixOf">fixOf</span><span class="symbol">:</span> <a href="../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/expectedRate">expectedRate</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigDecimal.html"><span class="identifier">BigDecimal</span></a><span class="symbol">, </span><span class="identifier" id="protocols.RatesFixProtocol$<init>(core.TransactionBuilder, core.messaging.LegallyIdentifiableNode, core.FixOf, java.math.BigDecimal, java.math.BigDecimal)/rateTolerance">rateTolerance</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigDecimal.html"><span class="identifier">BigDecimal</span></a><span class="symbol">)</span></code><p>This protocol queries the given oracle for an interest rate fix, and if it is within the given tolerance embeds the
|
||||
fix in the transaction and then proceeds to get the oracle to sign it. Although the <a href="call.html">call</a> method combines the query
|
||||
and signing step, you can run the steps individually by constructing this object and then using the public methods
|
||||
for each step.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="progress-tracker.html">progressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><p>Override this to provide a <a href="../../core.utilities/-progress-tracker/index.html">ProgressTracker</a>. If one is provided and stepped, the framework will do something
|
||||
helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
|
||||
tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
|
||||
progress.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="tx.html">tx</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">tx</span><span class="symbol">: </span><a href="../../core/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/logger.html">logger</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">logger</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>This is where you should log things to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/psm.html">psm</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">lateinit</span> <span class="keyword">var </span><span class="identifier">psm</span><span class="symbol">: </span><a href="../../core.protocols/-protocol-state-machine/index.html"><span class="identifier">ProtocolStateMachine</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span></code><p>Reference to the <a href="#">Fiber</a> instance that is the top level controller for the entire flow.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/service-hub.html">serviceHub</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">serviceHub</span><span class="symbol">: </span><a href="../../core.node.services/-service-hub/index.html"><span class="identifier">ServiceHub</span></a></code><p>Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="before-signing.html">beforeSigning</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">beforeSigning</span><span class="symbol">(</span><span class="identifier" id="protocols.RatesFixProtocol$beforeSigning(core.Fix)/fix">fix</span><span class="symbol">:</span> <a href="../../core/-fix/index.html"><span class="identifier">Fix</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>You can override this to perform any additional work needed after the fix is added to the transaction but
|
||||
before its sent back to the oracle for signing (for example, adding output states that depend on the fix).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="call.html">call</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>This is where you fill out your business logic.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="query.html">query</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">query</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core/-fix/index.html"><span class="identifier">Fix</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sign.html">sign</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">sign</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-digital-signature/-legally-identifiable/index.html"><span class="identifier">LegallyIdentifiable</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/receive.html">receive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">receive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/send.html">send</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">send</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/send-and-receive.html">sendAndReceive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">sendAndReceive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForSend">sessionIDForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/sub-protocol.html">subProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span> <span class="identifier">subProtocol</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$subProtocol(core.protocols.ProtocolLogic((core.protocols.ProtocolLogic.subProtocol.R)))/subLogic">subLogic</span><span class="symbol">:</span> <a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">R</span></code><p>Invokes the given subprotocol by simply passing through this <a href="../../core.protocols/-protocol-logic/index.html">ProtocolLogic</a>s reference to the
|
||||
<a href="../../core.protocols/-protocol-state-machine/index.html">ProtocolStateMachine</a> and then calling the <a href="../../core.protocols/-protocol-logic/call.html">call</a> method.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Companion Object Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c.html">TOPIC</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
24
docs/build/html/api/protocols/-rates-fix-protocol/progress-tracker.html
vendored
Normal file
24
docs/build/html/api/protocols/-rates-fix-protocol/progress-tracker.html
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.progressTracker - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">progressTracker</a><br/>
|
||||
<br/>
|
||||
<h1>progressTracker</h1>
|
||||
<a name="protocols.RatesFixProtocol$progressTracker"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><br/>
|
||||
Overrides <a href="../../core.protocols/-protocol-logic/progress-tracker.html">ProtocolLogic.progressTracker</a><br/>
|
||||
<p>Override this to provide a <a href="../../core.utilities/-progress-tracker/index.html">ProgressTracker</a>. If one is provided and stepped, the framework will do something
|
||||
helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
|
||||
tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
|
||||
progress.</p>
|
||||
<p>Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
|
||||
through.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/query.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/query.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.query - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">query</a><br/>
|
||||
<br/>
|
||||
<h1>query</h1>
|
||||
<a name="protocols.RatesFixProtocol$query()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">query</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core/-fix/index.html"><span class="identifier">Fix</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/sign.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/sign.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.sign - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">sign</a><br/>
|
||||
<br/>
|
||||
<h1>sign</h1>
|
||||
<a name="protocols.RatesFixProtocol$sign()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">sign</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-digital-signature/-legally-identifiable/index.html"><span class="identifier">LegallyIdentifiable</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-rates-fix-protocol/tx.html
vendored
Normal file
15
docs/build/html/api/protocols/-rates-fix-protocol/tx.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatesFixProtocol.tx - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">RatesFixProtocol</a> / <a href=".">tx</a><br/>
|
||||
<br/>
|
||||
<h1>tx</h1>
|
||||
<a name="protocols.RatesFixProtocol$tx"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">val </span><span class="identifier">tx</span><span class="symbol">: </span><a href="../../core/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>ResolveTransactionsProtocol.ExcessivelyLargeTransactionGraph.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">ResolveTransactionsProtocol</a> / <a href="index.html">ExcessivelyLargeTransactionGraph</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">ExcessivelyLargeTransactionGraph</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,25 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>ResolveTransactionsProtocol.ExcessivelyLargeTransactionGraph - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">ResolveTransactionsProtocol</a> / <a href=".">ExcessivelyLargeTransactionGraph</a><br/>
|
||||
<br/>
|
||||
<h1>ExcessivelyLargeTransactionGraph</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">ExcessivelyLargeTransactionGraph</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">ExcessivelyLargeTransactionGraph</span><span class="symbol">(</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
28
docs/build/html/api/protocols/-resolve-transactions-protocol/-init-.html
vendored
Normal file
28
docs/build/html/api/protocols/-resolve-transactions-protocol/-init-.html
vendored
Normal file
@ -0,0 +1,28 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>ResolveTransactionsProtocol.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">ResolveTransactionsProtocol</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">ResolveTransactionsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(core.SignedTransaction, core.messaging.SingleMessageRecipient)/stx">stx</span><span class="symbol">:</span> <a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">, </span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(core.SignedTransaction, core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">ResolveTransactionsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient)/wtx">wtx</span><span class="symbol">:</span> <a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">, </span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<code><span class="identifier">ResolveTransactionsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/txHashes">txHashes</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>This protocol fetches each transaction identified by the given hashes from either disk or network, along with all
|
||||
their dependencies, and verifies them together using a single <a href="../../core/-transaction-group/index.html">TransactionGroup</a>. If no exception is thrown, then
|
||||
all the transactions have been successfully verified and inserted into the local database.</p>
|
||||
<p>A couple of constructors are provided that accept a single transaction. When these are used, the dependencies of that
|
||||
transaction are resolved and then the transaction itself is verified. Again, if successful, the results are inserted
|
||||
into the database as long as a <a href="../../core/-signed-transaction/index.html">SignedTransaction</a> was provided. If only the <a href="../../core/-wire-transaction/index.html">WireTransaction</a> form was provided
|
||||
then this isnt enough to put into the local database, so only the dependencies are inserted. This way to use the
|
||||
protocol is helpful when resolving and verifying a finished but partially signed transaction.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-resolve-transactions-protocol/call.html
vendored
Normal file
17
docs/build/html/api/protocols/-resolve-transactions-protocol/call.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>ResolveTransactionsProtocol.call - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">ResolveTransactionsProtocol</a> / <a href=".">call</a><br/>
|
||||
<br/>
|
||||
<h1>call</h1>
|
||||
<a name="protocols.ResolveTransactionsProtocol$call()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
Overrides <a href="../../core.protocols/-protocol-logic/call.html">ProtocolLogic.call</a><br/>
|
||||
<p>This is where you fill out your business logic.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
129
docs/build/html/api/protocols/-resolve-transactions-protocol/index.html
vendored
Normal file
129
docs/build/html/api/protocols/-resolve-transactions-protocol/index.html
vendored
Normal file
@ -0,0 +1,129 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>ResolveTransactionsProtocol - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">ResolveTransactionsProtocol</a><br/>
|
||||
<br/>
|
||||
<h1>ResolveTransactionsProtocol</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">ResolveTransactionsProtocol</span> <span class="symbol">:</span> <a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><span class="identifier">Unit</span><span class="symbol">></span></code><br/>
|
||||
<p>This protocol fetches each transaction identified by the given hashes from either disk or network, along with all
|
||||
their dependencies, and verifies them together using a single <a href="../../core/-transaction-group/index.html">TransactionGroup</a>. If no exception is thrown, then
|
||||
all the transactions have been successfully verified and inserted into the local database.</p>
|
||||
<p>A couple of constructors are provided that accept a single transaction. When these are used, the dependencies of that
|
||||
transaction are resolved and then the transaction itself is verified. Again, if successful, the results are inserted
|
||||
into the database as long as a <a href="../../core/-signed-transaction/index.html">SignedTransaction</a> was provided. If only the <a href="../../core/-wire-transaction/index.html">WireTransaction</a> form was provided
|
||||
then this isnt enough to put into the local database, so only the dependencies are inserted. This way to use the
|
||||
protocol is helpful when resolving and verifying a finished but partially signed transaction.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Exceptions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-excessively-large-transaction-graph/index.html">ExcessivelyLargeTransactionGraph</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">ExcessivelyLargeTransactionGraph</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">ResolveTransactionsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(core.SignedTransaction, core.messaging.SingleMessageRecipient)/stx">stx</span><span class="symbol">:</span> <a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">, </span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(core.SignedTransaction, core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">ResolveTransactionsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient)/wtx">wtx</span><span class="symbol">:</span> <a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">, </span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(core.WireTransaction, core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><code><span class="identifier">ResolveTransactionsProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/txHashes">txHashes</span><span class="symbol">:</span> <span class="identifier">Set</span><span class="symbol"><</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.ResolveTransactionsProtocol$<init>(kotlin.collections.Set((core.crypto.SecureHash)), core.messaging.SingleMessageRecipient)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">)</span></code><p>This protocol fetches each transaction identified by the given hashes from either disk or network, along with all
|
||||
their dependencies, and verifies them together using a single <a href="../../core/-transaction-group/index.html">TransactionGroup</a>. If no exception is thrown, then
|
||||
all the transactions have been successfully verified and inserted into the local database.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/logger.html">logger</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">logger</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>This is where you should log things to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/progress-tracker.html">progressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a><span class="symbol">?</span></code><p>Override this to provide a <a href="../../core.utilities/-progress-tracker/index.html">ProgressTracker</a>. If one is provided and stepped, the framework will do something
|
||||
helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
|
||||
tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
|
||||
progress.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/psm.html">psm</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">lateinit</span> <span class="keyword">var </span><span class="identifier">psm</span><span class="symbol">: </span><a href="../../core.protocols/-protocol-state-machine/index.html"><span class="identifier">ProtocolStateMachine</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span></code><p>Reference to the <a href="#">Fiber</a> instance that is the top level controller for the entire flow.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/service-hub.html">serviceHub</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">serviceHub</span><span class="symbol">: </span><a href="../../core.node.services/-service-hub/index.html"><span class="identifier">ServiceHub</span></a></code><p>Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="call.html">call</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>This is where you fill out your business logic.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/receive.html">receive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">receive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/send.html">send</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">send</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/send-and-receive.html">sendAndReceive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">sendAndReceive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForSend">sessionIDForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/sub-protocol.html">subProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span> <span class="identifier">subProtocol</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$subProtocol(core.protocols.ProtocolLogic((core.protocols.ProtocolLogic.subProtocol.R)))/subLogic">subLogic</span><span class="symbol">:</span> <a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">R</span></code><p>Invokes the given subprotocol by simply passing through this <a href="../../core.protocols/-protocol-logic/index.html">ProtocolLogic</a>s reference to the
|
||||
<a href="../../core.protocols/-protocol-state-machine/index.html">ProtocolStateMachine</a> and then calling the <a href="../../core.protocols/-protocol-logic/call.html">call</a> method.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-timestamping-protocol/-client/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-timestamping-protocol/-client/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Client.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href="index.html">Client</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Client</span><span class="symbol">(</span><span class="identifier" id="protocols.TimestampingProtocol.Client$<init>(core.messaging.StateMachineManager, core.messaging.LegallyIdentifiableNode)/stateMachineManager">stateMachineManager</span><span class="symbol">:</span> <a href="../../../core.messaging/-state-machine-manager/index.html"><span class="identifier">StateMachineManager</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TimestampingProtocol.Client$<init>(core.messaging.StateMachineManager, core.messaging.LegallyIdentifiableNode)/node">node</span><span class="symbol">:</span> <a href="../../../core.messaging/-legally-identifiable-node/index.html"><span class="identifier">LegallyIdentifiableNode</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-timestamping-protocol/-client/identity.html
vendored
Normal file
17
docs/build/html/api/protocols/-timestamping-protocol/-client/identity.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Client.identity - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href="index.html">Client</a> / <a href=".">identity</a><br/>
|
||||
<br/>
|
||||
<h1>identity</h1>
|
||||
<a name="protocols.TimestampingProtocol.Client$identity"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">identity</span><span class="symbol">: </span><a href="../../../core/-party/index.html"><span class="identifier">Party</span></a></code><br/>
|
||||
Overrides <a href="../../../core.node.services/-timestamper-service/identity.html">TimestamperService.identity</a><br/>
|
||||
<p>The name+pubkey that this timestamper will sign with.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
docs/build/html/api/protocols/-timestamping-protocol/-client/index.html
vendored
Normal file
48
docs/build/html/api/protocols/-timestamping-protocol/-client/index.html
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Client - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href=".">Client</a><br/>
|
||||
<br/>
|
||||
<h1>Client</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Client</span> <span class="symbol">:</span> <a href="../../../core.node.services/-timestamper-service/index.html"><span class="identifier">TimestamperService</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Client</span><span class="symbol">(</span><span class="identifier" id="protocols.TimestampingProtocol.Client$<init>(core.messaging.StateMachineManager, core.messaging.LegallyIdentifiableNode)/stateMachineManager">stateMachineManager</span><span class="symbol">:</span> <a href="../../../core.messaging/-state-machine-manager/index.html"><span class="identifier">StateMachineManager</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TimestampingProtocol.Client$<init>(core.messaging.StateMachineManager, core.messaging.LegallyIdentifiableNode)/node">node</span><span class="symbol">:</span> <a href="../../../core.messaging/-legally-identifiable-node/index.html"><span class="identifier">LegallyIdentifiableNode</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="identity.html">identity</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">identity</span><span class="symbol">: </span><a href="../../../core/-party/index.html"><span class="identifier">Party</span></a></code><p>The name+pubkey that this timestamper will sign with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="timestamp.html">timestamp</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">timestamp</span><span class="symbol">(</span><span class="identifier" id="protocols.TimestampingProtocol.Client$timestamp(core.serialization.SerializedBytes((core.WireTransaction)))/wtxBytes">wtxBytes</span><span class="symbol">:</span> <a href="../../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol"><</span><a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../core.crypto/-digital-signature/-legally-identifiable/index.html"><span class="identifier">LegallyIdentifiable</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-timestamping-protocol/-client/timestamp.html
vendored
Normal file
16
docs/build/html/api/protocols/-timestamping-protocol/-client/timestamp.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Client.timestamp - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href="index.html">Client</a> / <a href=".">timestamp</a><br/>
|
||||
<br/>
|
||||
<h1>timestamp</h1>
|
||||
<a name="protocols.TimestampingProtocol.Client$timestamp(core.serialization.SerializedBytes((core.WireTransaction)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">timestamp</span><span class="symbol">(</span><span class="identifier" id="protocols.TimestampingProtocol.Client$timestamp(core.serialization.SerializedBytes((core.WireTransaction)))/wtxBytes">wtxBytes</span><span class="symbol">:</span> <a href="../../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol"><</span><a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../core.crypto/-digital-signature/-legally-identifiable/index.html"><span class="identifier">LegallyIdentifiable</span></a></code><br/>
|
||||
Overrides <a href="../../../core.node.services/-timestamper-service/timestamp.html">TimestamperService.timestamp</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
22
docs/build/html/api/protocols/-timestamping-protocol/-init-.html
vendored
Normal file
22
docs/build/html/api/protocols/-timestamping-protocol/-init-.html
vendored
Normal file
@ -0,0 +1,22 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">TimestampingProtocol</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">TimestampingProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.TimestampingProtocol$<init>(core.messaging.LegallyIdentifiableNode, core.serialization.SerializedBytes((core.WireTransaction)))/node">node</span><span class="symbol">:</span> <a href="../../core.messaging/-legally-identifiable-node/index.html"><span class="identifier">LegallyIdentifiableNode</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TimestampingProtocol$<init>(core.messaging.LegallyIdentifiableNode, core.serialization.SerializedBytes((core.WireTransaction)))/wtxBytes">wtxBytes</span><span class="symbol">:</span> <a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol"><</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">></span><span class="symbol">)</span></code><br/>
|
||||
<p>The TimestampingProtocol class is the client code that talks to a <a href="../../core.node.services/-node-timestamper-service/index.html">NodeTimestamperService</a> on some remote node. It is a
|
||||
<a href="../../core.protocols/-protocol-logic/index.html">ProtocolLogic</a>, meaning it can either be a sub-protocol of some other protocol, or be driven independently.</p>
|
||||
<p>If you are not yourself authoring a protocol and want to timestamp something, the <a href="-client/index.html">TimestampingProtocol.Client</a> class
|
||||
implements the <a href="../../core.node.services/-timestamper-service/index.html">TimestamperService</a> interface, meaning it can be passed to <a href="#">TransactionBuilder.timestamp</a> to timestamp
|
||||
the built transaction. Please be aware that this will block, meaning it should not be used on a thread that is handling
|
||||
a network message: use it only from spare application threads that dont have to respond to anything.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-timestamping-protocol/-request/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-timestamping-protocol/-request/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Request.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href="index.html">Request</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Request</span><span class="symbol">(</span><span class="identifier" id="protocols.TimestampingProtocol.Request$<init>(core.serialization.SerializedBytes((core.WireTransaction)), core.messaging.MessageRecipients, kotlin.String)/tx">tx</span><span class="symbol">:</span> <a href="../../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol"><</span><a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.TimestampingProtocol.Request$<init>(core.serialization.SerializedBytes((core.WireTransaction)), core.messaging.MessageRecipients, kotlin.String)/replyTo">replyTo</span><span class="symbol">:</span> <a href="../../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TimestampingProtocol.Request$<init>(core.serialization.SerializedBytes((core.WireTransaction)), core.messaging.MessageRecipients, kotlin.String)/replyToTopic">replyToTopic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
docs/build/html/api/protocols/-timestamping-protocol/-request/index.html
vendored
Normal file
48
docs/build/html/api/protocols/-timestamping-protocol/-request/index.html
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Request - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href=".">Request</a><br/>
|
||||
<br/>
|
||||
<h1>Request</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Request</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Request</span><span class="symbol">(</span><span class="identifier" id="protocols.TimestampingProtocol.Request$<init>(core.serialization.SerializedBytes((core.WireTransaction)), core.messaging.MessageRecipients, kotlin.String)/tx">tx</span><span class="symbol">:</span> <a href="../../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol"><</span><a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.TimestampingProtocol.Request$<init>(core.serialization.SerializedBytes((core.WireTransaction)), core.messaging.MessageRecipients, kotlin.String)/replyTo">replyTo</span><span class="symbol">:</span> <a href="../../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TimestampingProtocol.Request$<init>(core.serialization.SerializedBytes((core.WireTransaction)), core.messaging.MessageRecipients, kotlin.String)/replyToTopic">replyToTopic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="reply-to.html">replyTo</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyTo</span><span class="symbol">: </span><a href="../../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="reply-to-topic.html">replyToTopic</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyToTopic</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="tx.html">tx</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">tx</span><span class="symbol">: </span><a href="../../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol"><</span><a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to-topic.html
vendored
Normal file
15
docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to-topic.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Request.replyToTopic - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href="index.html">Request</a> / <a href=".">replyToTopic</a><br/>
|
||||
<br/>
|
||||
<h1>replyToTopic</h1>
|
||||
<a name="protocols.TimestampingProtocol.Request$replyToTopic"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyToTopic</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to.html
vendored
Normal file
15
docs/build/html/api/protocols/-timestamping-protocol/-request/reply-to.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Request.replyTo - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href="index.html">Request</a> / <a href=".">replyTo</a><br/>
|
||||
<br/>
|
||||
<h1>replyTo</h1>
|
||||
<a name="protocols.TimestampingProtocol.Request$replyTo"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyTo</span><span class="symbol">: </span><a href="../../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-timestamping-protocol/-request/tx.html
vendored
Normal file
15
docs/build/html/api/protocols/-timestamping-protocol/-request/tx.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.Request.tx - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TimestampingProtocol</a> / <a href="index.html">Request</a> / <a href=".">tx</a><br/>
|
||||
<br/>
|
||||
<h1>tx</h1>
|
||||
<a name="protocols.TimestampingProtocol.Request$tx"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">tx</span><span class="symbol">: </span><a href="../../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol"><</span><a href="../../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-timestamping-protocol/call.html
vendored
Normal file
17
docs/build/html/api/protocols/-timestamping-protocol/call.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol.call - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">TimestampingProtocol</a> / <a href=".">call</a><br/>
|
||||
<br/>
|
||||
<h1>call</h1>
|
||||
<a name="protocols.TimestampingProtocol$call()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-digital-signature/-legally-identifiable/index.html"><span class="identifier">LegallyIdentifiable</span></a></code><br/>
|
||||
Overrides <a href="../../core.protocols/-protocol-logic/call.html">ProtocolLogic.call</a><br/>
|
||||
<p>This is where you fill out your business logic.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
131
docs/build/html/api/protocols/-timestamping-protocol/index.html
vendored
Normal file
131
docs/build/html/api/protocols/-timestamping-protocol/index.html
vendored
Normal file
@ -0,0 +1,131 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TimestampingProtocol - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">TimestampingProtocol</a><br/>
|
||||
<br/>
|
||||
<h1>TimestampingProtocol</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">TimestampingProtocol</span> <span class="symbol">:</span> <a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><a href="../../core.crypto/-digital-signature/-legally-identifiable/index.html"><span class="identifier">LegallyIdentifiable</span></a><span class="symbol">></span></code><br/>
|
||||
<p>The TimestampingProtocol class is the client code that talks to a <a href="../../core.node.services/-node-timestamper-service/index.html">NodeTimestamperService</a> on some remote node. It is a
|
||||
<a href="../../core.protocols/-protocol-logic/index.html">ProtocolLogic</a>, meaning it can either be a sub-protocol of some other protocol, or be driven independently.</p>
|
||||
<p>If you are not yourself authoring a protocol and want to timestamp something, the <a href="-client/index.html">TimestampingProtocol.Client</a> class
|
||||
implements the <a href="../../core.node.services/-timestamper-service/index.html">TimestamperService</a> interface, meaning it can be passed to <a href="#">TransactionBuilder.timestamp</a> to timestamp
|
||||
the built transaction. Please be aware that this will block, meaning it should not be used on a thread that is handling
|
||||
a network message: use it only from spare application threads that dont have to respond to anything.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-client/index.html">Client</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Client</span> <span class="symbol">:</span> <a href="../../core.node.services/-timestamper-service/index.html"><span class="identifier">TimestamperService</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-request/index.html">Request</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Request</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">TimestampingProtocol</span><span class="symbol">(</span><span class="identifier" id="protocols.TimestampingProtocol$<init>(core.messaging.LegallyIdentifiableNode, core.serialization.SerializedBytes((core.WireTransaction)))/node">node</span><span class="symbol">:</span> <a href="../../core.messaging/-legally-identifiable-node/index.html"><span class="identifier">LegallyIdentifiableNode</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TimestampingProtocol$<init>(core.messaging.LegallyIdentifiableNode, core.serialization.SerializedBytes((core.WireTransaction)))/wtxBytes">wtxBytes</span><span class="symbol">:</span> <a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol"><</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">></span><span class="symbol">)</span></code><p>The TimestampingProtocol class is the client code that talks to a <a href="../../core.node.services/-node-timestamper-service/index.html">NodeTimestamperService</a> on some remote node. It is a
|
||||
<a href="../../core.protocols/-protocol-logic/index.html">ProtocolLogic</a>, meaning it can either be a sub-protocol of some other protocol, or be driven independently.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/logger.html">logger</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">logger</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>This is where you should log things to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/progress-tracker.html">progressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a><span class="symbol">?</span></code><p>Override this to provide a <a href="../../core.utilities/-progress-tracker/index.html">ProgressTracker</a>. If one is provided and stepped, the framework will do something
|
||||
helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
|
||||
tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
|
||||
progress.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/psm.html">psm</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">lateinit</span> <span class="keyword">var </span><span class="identifier">psm</span><span class="symbol">: </span><a href="../../core.protocols/-protocol-state-machine/index.html"><span class="identifier">ProtocolStateMachine</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span></code><p>Reference to the <a href="#">Fiber</a> instance that is the top level controller for the entire flow.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/service-hub.html">serviceHub</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">serviceHub</span><span class="symbol">: </span><a href="../../core.node.services/-service-hub/index.html"><span class="identifier">ServiceHub</span></a></code><p>Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="call.html">call</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-digital-signature/-legally-identifiable/index.html"><span class="identifier">LegallyIdentifiable</span></a></code><p>This is where you fill out your business logic.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/receive.html">receive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">receive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/send.html">send</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">send</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/send-and-receive.html">sendAndReceive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">sendAndReceive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForSend">sessionIDForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../core.protocols/-protocol-logic/sub-protocol.html">subProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span> <span class="identifier">subProtocol</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$subProtocol(core.protocols.ProtocolLogic((core.protocols.ProtocolLogic.subProtocol.R)))/subLogic">subLogic</span><span class="symbol">:</span> <a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">R</span></code><p>Invokes the given subprotocol by simply passing through this <a href="../../core.protocols/-protocol-logic/index.html">ProtocolLogic</a>s reference to the
|
||||
<a href="../../core.protocols/-protocol-state-machine/index.html">ProtocolStateMachine</a> and then calling the <a href="../../core.protocols/-protocol-logic/call.html">call</a> method.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.AssetMismatchException.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">AssetMismatchException</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">AssetMismatchException</span><span class="symbol">(</span><span class="identifier" id="protocols.TwoPartyTradeProtocol.AssetMismatchException$<init>(kotlin.String, kotlin.String)/expectedTypeName">expectedTypeName</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.AssetMismatchException$<init>(kotlin.String, kotlin.String)/typeName">typeName</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.AssetMismatchException.expectedTypeName - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">AssetMismatchException</a> / <a href=".">expectedTypeName</a><br/>
|
||||
<br/>
|
||||
<h1>expectedTypeName</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.AssetMismatchException$expectedTypeName"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">expectedTypeName</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
53
docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/index.html
vendored
Normal file
53
docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/index.html
vendored
Normal file
@ -0,0 +1,53 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.AssetMismatchException - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href=".">AssetMismatchException</a><br/>
|
||||
<br/>
|
||||
<h1>AssetMismatchException</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">AssetMismatchException</span> <span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html"><span class="identifier">Exception</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">AssetMismatchException</span><span class="symbol">(</span><span class="identifier" id="protocols.TwoPartyTradeProtocol.AssetMismatchException$<init>(kotlin.String, kotlin.String)/expectedTypeName">expectedTypeName</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.AssetMismatchException$<init>(kotlin.String, kotlin.String)/typeName">typeName</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="expected-type-name.html">expectedTypeName</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">expectedTypeName</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="type-name.html">typeName</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">typeName</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="to-string.html">toString</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">toString</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/to-string.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.AssetMismatchException.toString - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">AssetMismatchException</a> / <a href=".">toString</a><br/>
|
||||
<br/>
|
||||
<h1>toString</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.AssetMismatchException$toString()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">toString</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/type-name.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-asset-mismatch-exception/type-name.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.AssetMismatchException.typeName - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">AssetMismatchException</a> / <a href=".">typeName</a><br/>
|
||||
<br/>
|
||||
<h1>typeName</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.AssetMismatchException$typeName"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">typeName</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Buyer</span><span class="symbol">(</span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/timestampingAuthority">timestampingAuthority</span><span class="symbol">:</span> <a href="../../../core/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/acceptablePrice">acceptablePrice</span><span class="symbol">:</span> <a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/typeToBuy">typeToBuy</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><span class="keyword">out</span> <a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
31
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-r-e-c-e-i-v-i-n-g.html
vendored
Normal file
31
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-r-e-c-e-i-v-i-n-g.html
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.RECEIVING - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">RECEIVING</a><br/>
|
||||
<br/>
|
||||
<h1>RECEIVING</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">RECEIVING</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/changes.html">changes</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">changes</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/label.html">label</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">label</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
31
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html
vendored
Normal file
31
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-s-i-g-n-i-n-g.html
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.SIGNING - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">SIGNING</a><br/>
|
||||
<br/>
|
||||
<h1>SIGNING</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">SIGNING</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/changes.html">changes</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">changes</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/label.html">label</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">label</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,31 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.SWAPPING_SIGNATURES - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">SWAPPING_SIGNATURES</a><br/>
|
||||
<br/>
|
||||
<h1>SWAPPING_SIGNATURES</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">SWAPPING_SIGNATURES</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/changes.html">changes</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">changes</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/label.html">label</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">label</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
31
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html
vendored
Normal file
31
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/-v-e-r-i-f-y-i-n-g.html
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.VERIFYING - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">VERIFYING</a><br/>
|
||||
<br/>
|
||||
<h1>VERIFYING</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">VERIFYING</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/changes.html">changes</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">changes</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.utilities/-progress-tracker/-step/label.html">label</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">label</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/acceptable-price.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.acceptablePrice - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">acceptablePrice</a><br/>
|
||||
<br/>
|
||||
<h1>acceptablePrice</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.Buyer$acceptablePrice"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">acceptablePrice</span><span class="symbol">: </span><a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/call.html
vendored
Normal file
17
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/call.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.call - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">call</a><br/>
|
||||
<br/>
|
||||
<h1>call</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.Buyer$call()"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a></code><br/>
|
||||
Overrides <a href="../../../core.protocols/-protocol-logic/call.html">ProtocolLogic.call</a><br/>
|
||||
<p>This is where you fill out your business logic.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
168
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/index.html
vendored
Normal file
168
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/index.html
vendored
Normal file
@ -0,0 +1,168 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href=".">Buyer</a><br/>
|
||||
<br/>
|
||||
<h1>Buyer</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Buyer</span> <span class="symbol">:</span> <a href="../../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><a href="../../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-r-e-c-e-i-v-i-n-g.html">RECEIVING</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">RECEIVING</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-s-i-g-n-i-n-g.html">SIGNING</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">SIGNING</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-s-w-a-p-p-i-n-g_-s-i-g-n-a-t-u-r-e-s.html">SWAPPING_SIGNATURES</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">SWAPPING_SIGNATURES</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-v-e-r-i-f-y-i-n-g.html">VERIFYING</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">VERIFYING</span> <span class="symbol">:</span> <a href="../../../core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Buyer</span><span class="symbol">(</span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/timestampingAuthority">timestampingAuthority</span><span class="symbol">:</span> <a href="../../../core/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/acceptablePrice">acceptablePrice</span><span class="symbol">:</span> <a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/typeToBuy">typeToBuy</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><span class="keyword">out</span> <a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.Buyer$<init>(core.messaging.SingleMessageRecipient, core.Party, core.Amount, java.lang.Class((core.OwnableState)), kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="acceptable-price.html">acceptablePrice</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">acceptablePrice</span><span class="symbol">: </span><a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="other-side.html">otherSide</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">otherSide</span><span class="symbol">: </span><a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="progress-tracker.html">progressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../../core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><p>Override this to provide a <a href="../../../core.utilities/-progress-tracker/index.html">ProgressTracker</a>. If one is provided and stepped, the framework will do something
|
||||
helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
|
||||
tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
|
||||
progress.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="session-i-d.html">sessionID</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionID</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="timestamping-authority.html">timestampingAuthority</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">timestampingAuthority</span><span class="symbol">: </span><a href="../../../core/-party/index.html"><span class="identifier">Party</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="type-to-buy.html">typeToBuy</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">typeToBuy</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><span class="keyword">out</span> <a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.protocols/-protocol-logic/logger.html">logger</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">logger</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>This is where you should log things to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.protocols/-protocol-logic/psm.html">psm</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">lateinit</span> <span class="keyword">var </span><span class="identifier">psm</span><span class="symbol">: </span><a href="../../../core.protocols/-protocol-state-machine/index.html"><span class="identifier">ProtocolStateMachine</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span></code><p>Reference to the <a href="#">Fiber</a> instance that is the top level controller for the entire flow.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.protocols/-protocol-logic/service-hub.html">serviceHub</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">serviceHub</span><span class="symbol">: </span><a href="../../../core.node.services/-service-hub/index.html"><span class="identifier">ServiceHub</span></a></code><p>Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="call.html">call</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a></code><p>This is where you fill out your business logic.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.protocols/-protocol-logic/receive.html">receive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">receive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.protocols/-protocol-logic/send.html">send</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">send</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$send(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.protocols/-protocol-logic/send-and-receive.html">sendAndReceive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="identifier">sendAndReceive</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../../core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForSend">sessionIDForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, core.messaging.MessageRecipients, kotlin.Long, kotlin.Long, kotlin.Any)/obj">obj</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../core.utilities/-untrustworthy-data/index.html"><span class="identifier">UntrustworthyData</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../core.protocols/-protocol-logic/sub-protocol.html">subProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span> <span class="identifier">subProtocol</span><span class="symbol">(</span><span class="identifier" id="core.protocols.ProtocolLogic$subProtocol(core.protocols.ProtocolLogic((core.protocols.ProtocolLogic.subProtocol.R)))/subLogic">subLogic</span><span class="symbol">:</span> <a href="../../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><span class="identifier">R</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">R</span></code><p>Invokes the given subprotocol by simply passing through this <a href="../../../core.protocols/-protocol-logic/index.html">ProtocolLogic</a>s reference to the
|
||||
<a href="../../../core.protocols/-protocol-state-machine/index.html">ProtocolStateMachine</a> and then calling the <a href="../../../core.protocols/-protocol-logic/call.html">call</a> method.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/other-side.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/other-side.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.otherSide - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">otherSide</a><br/>
|
||||
<br/>
|
||||
<h1>otherSide</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.Buyer$otherSide"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">otherSide</span><span class="symbol">: </span><a href="../../../core.messaging/-single-message-recipient.html"><span class="identifier">SingleMessageRecipient</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
24
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/progress-tracker.html
vendored
Normal file
24
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/progress-tracker.html
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.progressTracker - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">progressTracker</a><br/>
|
||||
<br/>
|
||||
<h1>progressTracker</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.Buyer$progressTracker"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../../core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><br/>
|
||||
Overrides <a href="../../../core.protocols/-protocol-logic/progress-tracker.html">ProtocolLogic.progressTracker</a><br/>
|
||||
<p>Override this to provide a <a href="../../../core.utilities/-progress-tracker/index.html">ProgressTracker</a>. If one is provided and stepped, the framework will do something
|
||||
helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the
|
||||
tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track
|
||||
progress.</p>
|
||||
<p>Note that this has to return a tracker before the protocol is invoked. You cant change your mind half way
|
||||
through.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/session-i-d.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/session-i-d.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.sessionID - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">sessionID</a><br/>
|
||||
<br/>
|
||||
<h1>sessionID</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.Buyer$sessionID"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionID</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/timestamping-authority.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/timestamping-authority.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.timestampingAuthority - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">timestampingAuthority</a><br/>
|
||||
<br/>
|
||||
<h1>timestampingAuthority</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.Buyer$timestampingAuthority"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">timestampingAuthority</span><span class="symbol">: </span><a href="../../../core/-party/index.html"><span class="identifier">Party</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/type-to-buy.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-buyer/type-to-buy.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.Buyer.typeToBuy - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">Buyer</a> / <a href=".">typeToBuy</a><br/>
|
||||
<br/>
|
||||
<h1>typeToBuy</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.Buyer$typeToBuy"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">typeToBuy</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><span class="keyword">out</span> <a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.SellerTradeInfo.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">SellerTradeInfo</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">SellerTradeInfo</span><span class="symbol">(</span><span class="identifier" id="protocols.TwoPartyTradeProtocol.SellerTradeInfo$<init>(core.StateAndRef((core.OwnableState)), core.Amount, java.security.PublicKey, kotlin.Long)/assetForSale">assetForSale</span><span class="symbol">:</span> <a href="../../../core/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.SellerTradeInfo$<init>(core.StateAndRef((core.OwnableState)), core.Amount, java.security.PublicKey, kotlin.Long)/price">price</span><span class="symbol">:</span> <a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.SellerTradeInfo$<init>(core.StateAndRef((core.OwnableState)), core.Amount, java.security.PublicKey, kotlin.Long)/sellerOwnerKey">sellerOwnerKey</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.SellerTradeInfo$<init>(core.StateAndRef((core.OwnableState)), core.Amount, java.security.PublicKey, kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/asset-for-sale.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/asset-for-sale.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.SellerTradeInfo.assetForSale - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">SellerTradeInfo</a> / <a href=".">assetForSale</a><br/>
|
||||
<br/>
|
||||
<h1>assetForSale</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.SellerTradeInfo$assetForSale"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">assetForSale</span><span class="symbol">: </span><a href="../../../core/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
54
docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/index.html
vendored
Normal file
54
docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/index.html
vendored
Normal file
@ -0,0 +1,54 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.SellerTradeInfo - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href=".">SellerTradeInfo</a><br/>
|
||||
<br/>
|
||||
<h1>SellerTradeInfo</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">SellerTradeInfo</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">SellerTradeInfo</span><span class="symbol">(</span><span class="identifier" id="protocols.TwoPartyTradeProtocol.SellerTradeInfo$<init>(core.StateAndRef((core.OwnableState)), core.Amount, java.security.PublicKey, kotlin.Long)/assetForSale">assetForSale</span><span class="symbol">:</span> <a href="../../../core/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.SellerTradeInfo$<init>(core.StateAndRef((core.OwnableState)), core.Amount, java.security.PublicKey, kotlin.Long)/price">price</span><span class="symbol">:</span> <a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.SellerTradeInfo$<init>(core.StateAndRef((core.OwnableState)), core.Amount, java.security.PublicKey, kotlin.Long)/sellerOwnerKey">sellerOwnerKey</span><span class="symbol">:</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">, </span><span class="identifier" id="protocols.TwoPartyTradeProtocol.SellerTradeInfo$<init>(core.StateAndRef((core.OwnableState)), core.Amount, java.security.PublicKey, kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="asset-for-sale.html">assetForSale</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">assetForSale</span><span class="symbol">: </span><a href="../../../core/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="price.html">price</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">price</span><span class="symbol">: </span><a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="seller-owner-key.html">sellerOwnerKey</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sellerOwnerKey</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="session-i-d.html">sessionID</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionID</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/price.html
vendored
Normal file
15
docs/build/html/api/protocols/-two-party-trade-protocol/-seller-trade-info/price.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>TwoPartyTradeProtocol.SellerTradeInfo.price - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">TwoPartyTradeProtocol</a> / <a href="index.html">SellerTradeInfo</a> / <a href=".">price</a><br/>
|
||||
<br/>
|
||||
<h1>price</h1>
|
||||
<a name="protocols.TwoPartyTradeProtocol.SellerTradeInfo$price"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">price</span><span class="symbol">: </span><a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user