ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-06-12 20:28:18 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Regen docsite

Browse Source
This commit is contained in:
Mike Hearn
2016-03-14 16:57:36 +01:00
parent d664ecf891
commit bc5f29c5ee
131 changed files with 3824 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/build/html/api/protocols/-rates-fix-protocol/-fix-out-of-range/-init-.html vendored Normal file
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">FixOutOfRange</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</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>&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">FixOutOfRange</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href=".">FixOutOfRange</a><br/>
<br/>
<h1>FixOutOfRange</h1>
<code><span class="keyword">class </span><span class="identifier">FixOutOfRange</span>&nbsp;<span class="symbol">:</span>&nbsp;<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">&lt;init&gt;</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>&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">QUERYING</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</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>&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href=".">QUERYING</a><br/>
<br/>
<h1>QUERYING</h1>
<code><span class="keyword">class </span><span class="identifier">QUERYING</span>&nbsp;<span class="symbol">:</span>&nbsp;<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">&lt;init&gt;</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>&nbsp;<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">&lt;ERROR CLASS&gt;</span><span class="symbol">&lt;</span><a href="../../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">&gt;</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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">QUERYING</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">QueryRequest</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</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>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">&gt;</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>&nbsp;<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>&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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">&lt;init&gt;</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>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">&gt;</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>&nbsp;<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>&nbsp;<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">&lt;</span><a href="../../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">&gt;</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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">QueryRequest</a>&nbsp;/&nbsp;<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">&lt;</span><a href="../../../core/-fix-of/index.html"><span class="identifier">FixOf</span></a><span class="symbol">&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/protocols/-rates-fix-protocol/-query-request/reply-to.html vendored Normal file
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">QueryRequest</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">QueryRequest</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href=".">SIGNING</a><br/>
<br/>
<h1>SIGNING</h1>
<code><span class="keyword">object </span><span class="identifier">SIGNING</span>&nbsp;<span class="symbol">:</span>&nbsp;<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">&lt;ERROR CLASS&gt;</span><span class="symbol">&lt;</span><a href="../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">&gt;</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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">SignRequest</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</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>&nbsp;<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>&nbsp;<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>&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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">&lt;init&gt;</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>&nbsp;<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>&nbsp;<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>&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">SignRequest</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">SignRequest</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="../index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href="index.html">SignRequest</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<a href=".">WORKING</a><br/>
<br/>
<h1>WORKING</h1>
<code><span class="keyword">object </span><span class="identifier">WORKING</span>&nbsp;<span class="symbol">:</span>&nbsp;<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">&lt;ERROR CLASS&gt;</span><span class="symbol">&lt;</span><a href="../../core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">&gt;</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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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>&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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
View File

@ -0,0 +1,203 @@
<HTML>
<HEAD>
<title>RatesFixProtocol - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">protocols</a>&nbsp;/&nbsp;<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>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol">&lt;</span><span class="identifier">Unit</span><span class="symbol">&gt;</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>&nbsp;<span class="symbol">:</span>&nbsp;<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>&nbsp;<span class="symbol">:</span>&nbsp;<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>&nbsp;<span class="symbol">:</span>&nbsp;<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>&nbsp;<span class="symbol">:</span>&nbsp;<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">&lt;init&gt;</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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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">&lt;ERROR CLASS&gt;</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">&lt;</span><span class="identifier">*</span><span class="symbol">&gt;</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>&nbsp;<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">&lt;</span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Any</span><span class="symbol">&gt;</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>&nbsp;<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>&nbsp;<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">&lt;</span><span class="identifier">T</span><span class="symbol">&gt;</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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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">&lt;</span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Any</span><span class="symbol">&gt;</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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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">&lt;</span><span class="identifier">T</span><span class="symbol">&gt;</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">&lt;</span><span class="identifier">R</span><span class="symbol">&gt;</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>&nbsp;<a href="../../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol">&lt;</span><span class="identifier">R</span><span class="symbol">&gt;</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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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
View 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>&nbsp;/&nbsp;<a href="index.html">RatesFixProtocol</a>&nbsp;/&nbsp;<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>

10
docs/build/html/api/protocols/index.html vendored
View File

@ -34,6 +34,16 @@ attachments are saved to local storage automatically.</p>
</tr>
<tr>
<td>
<a href="-rates-fix-protocol/index.html">RatesFixProtocol</a></td>
<td>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">RatesFixProtocol</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol">&lt;</span><span class="identifier">Unit</span><span class="symbol">&gt;</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="-rates-fix-protocol/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>
<tr>
<td>
<a href="-resolve-transactions-protocol/index.html">ResolveTransactionsProtocol</a></td>
<td>
<code><span class="keyword">class </span><span class="identifier">ResolveTransactionsProtocol</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol">&lt;</span><span class="identifier">Unit</span><span class="symbol">&gt;</span></code><p>This protocol fetches each transaction identified by the given hashes from either disk or network, along with all