mirror of
https://github.com/corda/corda.git
synced 2025-06-16 14:18:20 +00:00
Regen docsite
This commit is contained in:
Mike Hearn
@ -0,0 +1,42 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.APPROVING - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">APPROVING</a><br/>
|
||||
<br/>
|
||||
<h1>APPROVING</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">APPROVING</span> <span class="symbol">:</span> <a href="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.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>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.core.utilities/-progress-tracker/-step/child-progress-tracker.html">childProgressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">childProgressTracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Acceptor</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/sessionIdForSend">sessionIdForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/sessionIdForReceive">sessionIdForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/progressTracker">progressTracker</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a> <span class="symbol">=</span> tracker()<span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,42 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.REJECTING - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">REJECTING</a><br/>
|
||||
<br/>
|
||||
<h1>REJECTING</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">REJECTING</span> <span class="symbol">:</span> <a href="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.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>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.core.utilities/-progress-tracker/-step/child-progress-tracker.html">childProgressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">childProgressTracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.TOPIC_CHANGE - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">TOPIC_CHANGE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_CHANGE</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Acceptor$TOPIC_CHANGE"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.TOPIC_INITIATE - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">TOPIC_INITIATE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_INITIATE</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Acceptor$TOPIC_INITIATE"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,42 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.VERIFYING - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</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="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.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>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.core.utilities/-progress-tracker/-step/child-progress-tracker.html">childProgressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">childProgressTracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/call.html
vendored
Normal file
17
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/call.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.call - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">call</a><br/>
|
||||
<br/>
|
||||
<h1>call</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Acceptor$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="../../../com.r3corda.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>
|
||||
187
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/index.html
vendored
Normal file
187
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/index.html
vendored
Normal file
@ -0,0 +1,187 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href=".">Acceptor</a><br/>
|
||||
<br/>
|
||||
<h1>Acceptor</h1>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">Acceptor</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../../com.r3corda.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/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-a-p-p-r-o-v-i-n-g.html">APPROVING</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">APPROVING</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/-step/index.html"><span class="identifier">Step</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-r-e-j-e-c-t-i-n-g.html">REJECTING</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">REJECTING</span> <span class="symbol">:</span> <a href="../../../com.r3corda.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="../../../com.r3corda.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">Acceptor</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/sessionIdForSend">sessionIdForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/sessionIdForReceive">sessionIdForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/progressTracker">progressTracker</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a> <span class="symbol">=</span> tracker()<span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-c-h-a-n-g-e.html">TOPIC_CHANGE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-i-n-i-t-i-a-t-e.html">TOPIC_INITIATE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></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="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</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="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><p>Override this to provide a <a href="../../../com.r3corda.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-id-for-receive.html">sessionIdForReceive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionIdForReceive</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="session-id-for-send.html">sessionIdForSend</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionIdForSend</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.core.node/-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. It is
|
||||
only available once the protocol has started, which means it cannnot be accessed in the constructor. Either
|
||||
access this lazily or from inside <a href="../../../com.r3corda.core.protocols/-protocol-logic/call.html">call</a>.</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><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="../../../com.r3corda.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="com.r3corda.core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long, java.lang.Class((com.r3corda.core.protocols.ProtocolLogic.receive.T)))/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long, java.lang.Class((com.r3corda.core.protocols.ProtocolLogic.receive.T)))/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long, java.lang.Class((com.r3corda.core.protocols.ProtocolLogic.receive.T)))/clazz">clazz</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="identifier">T</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.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><br/>
|
||||
<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="com.r3corda.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="com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.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="com.r3corda.core.protocols.ProtocolLogic$send(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$send(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$send(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Any)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$send(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Any)/payload">payload</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="../../../com.r3corda.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="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, 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="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, 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="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, 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="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, kotlin.Any)/payload">payload</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.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="../../../com.r3corda.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="com.r3corda.core.protocols.ProtocolLogic$subProtocol(com.r3corda.core.protocols.ProtocolLogic((com.r3corda.core.protocols.ProtocolLogic.subProtocol.R)))/subLogic">subLogic</span><span class="symbol">:</span> <a href="../../../com.r3corda.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="../../../com.r3corda.core.protocols/-protocol-logic/index.html">ProtocolLogic</a>s reference to the
|
||||
<a href="../../../com.r3corda.core.protocols/-protocol-state-machine/index.html">ProtocolStateMachine</a> and then calling the <a href="../../../com.r3corda.core.protocols/-protocol-logic/call.html">call</a> method.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Companion Object Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="tracker.html">tracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">tracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-notary-change-protocol/-acceptor/index.html">Acceptor</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Acceptor</span> <span class="symbol">:</span> <span class="identifier">Acceptor</span><span class="symbol"><</span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/other-side.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/other-side.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.otherSide - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">otherSide</a><br/>
|
||||
<br/>
|
||||
<h1>otherSide</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Acceptor$otherSide"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">otherSide</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,24 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.progressTracker - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">progressTracker</a><br/>
|
||||
<br/>
|
||||
<h1>progressTracker</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Acceptor$progressTracker"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.protocols/-protocol-logic/progress-tracker.html">ProtocolLogic.progressTracker</a><br/>
|
||||
<p>Override this to provide a <a href="../../../com.r3corda.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>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.sessionIdForReceive - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">sessionIdForReceive</a><br/>
|
||||
<br/>
|
||||
<h1>sessionIdForReceive</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Acceptor$sessionIdForReceive"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionIdForReceive</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.sessionIdForSend - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">sessionIdForSend</a><br/>
|
||||
<br/>
|
||||
<h1>sessionIdForSend</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Acceptor$sessionIdForSend"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionIdForSend</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/tracker.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-acceptor/tracker.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Acceptor.tracker - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">tracker</a><br/>
|
||||
<br/>
|
||||
<h1>tracker</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Acceptor.Companion$tracker()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">tracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-handshake/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-handshake/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Handshake.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Handshake</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Handshake</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Handshake$<init>(kotlin.Long, com.r3corda.core.crypto.Party, kotlin.Long)/sessionIdForSend">sessionIdForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Handshake$<init>(kotlin.Long, com.r3corda.core.crypto.Party, kotlin.Long)/replyTo">replyTo</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Handshake$<init>(kotlin.Long, com.r3corda.core.crypto.Party, kotlin.Long)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
64
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-handshake/index.html
vendored
Normal file
64
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-handshake/index.html
vendored
Normal file
@ -0,0 +1,64 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Handshake - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href=".">Handshake</a><br/>
|
||||
<br/>
|
||||
<h1>Handshake</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Handshake</span> <span class="symbol">:</span> <a href="../../../com.r3corda.protocols/-abstract-request-message/index.html"><span class="identifier">AbstractRequestMessage</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">Handshake</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Handshake$<init>(kotlin.Long, com.r3corda.core.crypto.Party, kotlin.Long)/sessionIdForSend">sessionIdForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Handshake$<init>(kotlin.Long, com.r3corda.core.crypto.Party, kotlin.Long)/replyTo">replyTo</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Handshake$<init>(kotlin.Long, com.r3corda.core.crypto.Party, 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="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="session-id-for-send.html">sessionIdForSend</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionIdForSend</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.protocols/-abstract-request-message/reply-to-party.html">replyToParty</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">replyToParty</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.protocols/-abstract-request-message/get-reply-to.html">getReplyTo</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getReplyTo</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.protocols.AbstractRequestMessage$getReplyTo(com.r3corda.core.node.services.NetworkMapCache)/networkMapCache">networkMapCache</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.node.services/-network-map-cache/index.html"><span class="identifier">NetworkMapCache</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.messaging/-message-recipients.html"><span class="identifier">MessageRecipients</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-handshake/session-i-d.html
vendored
Normal file
16
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-handshake/session-i-d.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Handshake.sessionID - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Handshake</a> / <a href=".">sessionID</a><br/>
|
||||
<br/>
|
||||
<h1>sessionID</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Handshake$sessionID"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionID</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.protocols/-service-request-message/session-i-d.html">ServiceRequestMessage.sessionID</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Handshake.sessionIdForSend - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Handshake</a> / <a href=".">sessionIdForSend</a><br/>
|
||||
<br/>
|
||||
<h1>sessionIdForSend</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Handshake$sessionIdForSend"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionIdForSend</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
23
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-init-.html
vendored
Normal file
23
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-init-.html
vendored
Normal file
@ -0,0 +1,23 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">AbstractStateReplacementProtocol</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">AbstractStateReplacementProtocol</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
|
||||
<p>Abstract protocol to be used for replacing one state with another, for example when changing the notary of a state.
|
||||
Notably this requires a one to one replacement of states, states cannot be split, merged or issued as part of these
|
||||
protocols.</p>
|
||||
<p>The <a href="-instigator/index.html">Instigator</a> assembles the transaction for state replacement and sends out change proposals to all participants
|
||||
(<a href="-acceptor/index.html">Acceptor</a>) of that state. If participants agree to the proposed change, they each sign the transaction.
|
||||
Finally, <a href="-instigator/index.html">Instigator</a> sends the transaction containing all signatures back to each participant so they can record it and
|
||||
use the new updated state for future transactions.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Instigator</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.AbstractStateReplacementProtocol.Instigator.S)), protocols.AbstractStateReplacementProtocol.Instigator.T, com.r3corda.core.utilities.ProgressTracker)/originalState">originalState</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.AbstractStateReplacementProtocol.Instigator.S)), protocols.AbstractStateReplacementProtocol.Instigator.T, com.r3corda.core.utilities.ProgressTracker)/modification">modification</span><span class="symbol">:</span> <span class="identifier">T</span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.AbstractStateReplacementProtocol.Instigator.S)), protocols.AbstractStateReplacementProtocol.Instigator.T, com.r3corda.core.utilities.ProgressTracker)/progressTracker">progressTracker</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a> <span class="symbol">=</span> tracker()<span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
42
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/-n-o-t-a-r-y.html
vendored
Normal file
42
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/-n-o-t-a-r-y.html
vendored
Normal file
@ -0,0 +1,42 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.NOTARY - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">NOTARY</a><br/>
|
||||
<br/>
|
||||
<h1>NOTARY</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">NOTARY</span> <span class="symbol">:</span> <a href="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.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>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.core.utilities/-progress-tracker/-step/child-progress-tracker.html">childProgressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">childProgressTracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,42 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.SIGNING - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</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="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.core.utilities/-progress-tracker/-change/index.html"><span class="identifier">Change</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.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>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.core.utilities/-progress-tracker/-step/child-progress-tracker.html">childProgressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">childProgressTracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.TOPIC_CHANGE - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">TOPIC_CHANGE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_CHANGE</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Instigator$TOPIC_CHANGE"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.TOPIC_INITIATE - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">TOPIC_INITIATE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_INITIATE</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Instigator$TOPIC_INITIATE"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
17
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/call.html
vendored
Normal file
17
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/call.html
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.call - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">call</a><br/>
|
||||
<br/>
|
||||
<h1>call</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Instigator$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="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.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>
|
||||
175
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/index.html
vendored
Normal file
175
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/index.html
vendored
Normal file
@ -0,0 +1,175 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href=".">Instigator</a><br/>
|
||||
<br/>
|
||||
<h1>Instigator</h1>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">Instigator</span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">, </span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-n-o-t-a-r-y.html">NOTARY</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">NOTARY</span> <span class="symbol">:</span> <a href="../../../com.r3corda.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="../../../com.r3corda.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">Instigator</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.AbstractStateReplacementProtocol.Instigator.S)), protocols.AbstractStateReplacementProtocol.Instigator.T, com.r3corda.core.utilities.ProgressTracker)/originalState">originalState</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.AbstractStateReplacementProtocol.Instigator.S)), protocols.AbstractStateReplacementProtocol.Instigator.T, com.r3corda.core.utilities.ProgressTracker)/modification">modification</span><span class="symbol">:</span> <span class="identifier">T</span><span class="symbol">, </span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.AbstractStateReplacementProtocol.Instigator.S)), protocols.AbstractStateReplacementProtocol.Instigator.T, com.r3corda.core.utilities.ProgressTracker)/progressTracker">progressTracker</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a> <span class="symbol">=</span> tracker()<span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-c-h-a-n-g-e.html">TOPIC_CHANGE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-i-n-i-t-i-a-t-e.html">TOPIC_INITIATE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="modification.html">modification</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">modification</span><span class="symbol">: </span><span class="identifier">T</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="original-state.html">originalState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">originalState</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span></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="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><p>Override this to provide a <a href="../../../com.r3corda.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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.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="../../../com.r3corda.core.node/-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. It is
|
||||
only available once the protocol has started, which means it cannnot be accessed in the constructor. Either
|
||||
access this lazily or from inside <a href="../../../com.r3corda.core.protocols/-protocol-logic/call.html">call</a>.</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="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></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="../../../com.r3corda.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="com.r3corda.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="com.r3corda.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="../../../com.r3corda.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><br/>
|
||||
<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="com.r3corda.core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long, java.lang.Class((com.r3corda.core.protocols.ProtocolLogic.receive.T)))/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long, java.lang.Class((com.r3corda.core.protocols.ProtocolLogic.receive.T)))/sessionIDForReceive">sessionIDForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$receive(kotlin.String, kotlin.Long, java.lang.Class((com.r3corda.core.protocols.ProtocolLogic.receive.T)))/clazz">clazz</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="identifier">T</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.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="../../../com.r3corda.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="com.r3corda.core.protocols.ProtocolLogic$send(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Any)/topic">topic</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$send(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$send(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Any)/sessionID">sessionID</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$send(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Any)/payload">payload</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="../../../com.r3corda.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="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, 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="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, kotlin.Any)/destination">destination</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, 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="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, 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="com.r3corda.core.protocols.ProtocolLogic$sendAndReceive(kotlin.String, com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, kotlin.Any)/payload">payload</span><span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.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="../../../com.r3corda.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="com.r3corda.core.protocols.ProtocolLogic$subProtocol(com.r3corda.core.protocols.ProtocolLogic((com.r3corda.core.protocols.ProtocolLogic.subProtocol.R)))/subLogic">subLogic</span><span class="symbol">:</span> <a href="../../../com.r3corda.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="../../../com.r3corda.core.protocols/-protocol-logic/index.html">ProtocolLogic</a>s reference to the
|
||||
<a href="../../../com.r3corda.core.protocols/-protocol-state-machine/index.html">ProtocolStateMachine</a> and then calling the <a href="../../../com.r3corda.core.protocols/-protocol-logic/call.html">call</a> method.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Companion Object Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="tracker.html">tracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">tracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-notary-change-protocol/-instigator/index.html">Instigator</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Instigator</span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Instigator</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">,</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/modification.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/modification.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.modification - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">modification</a><br/>
|
||||
<br/>
|
||||
<h1>modification</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Instigator$modification"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">modification</span><span class="symbol">: </span><span class="identifier">T</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.originalState - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">originalState</a><br/>
|
||||
<br/>
|
||||
<h1>originalState</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Instigator$originalState"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">originalState</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,24 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.progressTracker - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">progressTracker</a><br/>
|
||||
<br/>
|
||||
<h1>progressTracker</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Instigator$progressTracker"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.protocols/-protocol-logic/progress-tracker.html">ProtocolLogic.progressTracker</a><br/>
|
||||
<p>Override this to provide a <a href="../../../com.r3corda.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/-abstract-state-replacement-protocol/-instigator/tracker.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-instigator/tracker.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Instigator.tracker - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">tracker</a><br/>
|
||||
<br/>
|
||||
<h1>tracker</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Instigator.Companion$tracker()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">tracker</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-proposal/index.html
vendored
Normal file
48
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-proposal/index.html
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Proposal - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href=".">Proposal</a><br/>
|
||||
<br/>
|
||||
<h1>Proposal</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Proposal</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="modification.html">modification</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">modification</span><span class="symbol">: </span><span class="identifier">T</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="state-ref.html">stateRef</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">stateRef</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="stx.html">stx</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">stx</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-notary-change-protocol/-proposal/index.html">Proposal</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Proposal</span> <span class="symbol">:</span> <span class="identifier">Proposal</span><span class="symbol"><</span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-proposal/modification.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-proposal/modification.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Proposal.modification - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Proposal</a> / <a href=".">modification</a><br/>
|
||||
<br/>
|
||||
<h1>modification</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Proposal$modification"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">modification</span><span class="symbol">: </span><span class="identifier">T</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-proposal/state-ref.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-proposal/state-ref.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Proposal.stateRef - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Proposal</a> / <a href=".">stateRef</a><br/>
|
||||
<br/>
|
||||
<h1>stateRef</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Proposal$stateRef"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">stateRef</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-proposal/stx.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-proposal/stx.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Proposal.stx - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Proposal</a> / <a href=".">stx</a><br/>
|
||||
<br/>
|
||||
<h1>stx</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Proposal$stx"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">stx</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/error.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/error.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Result.error - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Result</a> / <a href=".">error</a><br/>
|
||||
<br/>
|
||||
<h1>error</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Result$error"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="../../-state-replacement-refused/index.html"><span class="identifier">StateReplacementRefused</span></a><span class="symbol">?</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/index.html
vendored
Normal file
48
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/index.html
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Result - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</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></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="error.html">error</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="../../-state-replacement-refused/index.html"><span class="identifier">StateReplacementRefused</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sig.html">sig</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sig</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Companion Object Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="no-error.html">noError</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">noError</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Result.Companion$noError(com.r3corda.core.crypto.DigitalSignature.WithKey)/sig">sig</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Result</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="with-error.html">withError</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withError</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Result.Companion$withError(protocols.StateReplacementRefused)/error">error</span><span class="symbol">:</span> <a href="../../-state-replacement-refused/index.html"><span class="identifier">StateReplacementRefused</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Result</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/no-error.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/no-error.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Result.noError - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Result</a> / <a href=".">noError</a><br/>
|
||||
<br/>
|
||||
<h1>noError</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Result.Companion$noError(com.r3corda.core.crypto.DigitalSignature.WithKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">noError</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Result.Companion$noError(com.r3corda.core.crypto.DigitalSignature.WithKey)/sig">sig</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">Result</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/sig.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/sig.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Result.sig - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Result</a> / <a href=".">sig</a><br/>
|
||||
<br/>
|
||||
<h1>sig</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Result$sig"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">sig</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a><span class="symbol">?</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/with-error.html
vendored
Normal file
15
docs/build/html/api/protocols/-abstract-state-replacement-protocol/-result/with-error.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol.Result.withError - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">AbstractStateReplacementProtocol</a> / <a href="index.html">Result</a> / <a href=".">withError</a><br/>
|
||||
<br/>
|
||||
<h1>withError</h1>
|
||||
<a name="protocols.AbstractStateReplacementProtocol.Result.Companion$withError(protocols.StateReplacementRefused)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withError</span><span class="symbol">(</span><span class="identifier" id="protocols.AbstractStateReplacementProtocol.Result.Companion$withError(protocols.StateReplacementRefused)/error">error</span><span class="symbol">:</span> <a href="../../-state-replacement-refused/index.html"><span class="identifier">StateReplacementRefused</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">Result</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
85
docs/build/html/api/protocols/-abstract-state-replacement-protocol/index.html
vendored
Normal file
85
docs/build/html/api/protocols/-abstract-state-replacement-protocol/index.html
vendored
Normal file
@ -0,0 +1,85 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>AbstractStateReplacementProtocol - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">AbstractStateReplacementProtocol</a><br/>
|
||||
<br/>
|
||||
<h1>AbstractStateReplacementProtocol</h1>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">AbstractStateReplacementProtocol</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<p>Abstract protocol to be used for replacing one state with another, for example when changing the notary of a state.
|
||||
Notably this requires a one to one replacement of states, states cannot be split, merged or issued as part of these
|
||||
protocols.</p>
|
||||
<p>The <a href="-instigator/index.html">Instigator</a> assembles the transaction for state replacement and sends out change proposals to all participants
|
||||
(<a href="-acceptor/index.html">Acceptor</a>) of that state. If participants agree to the proposed change, they each sign the transaction.
|
||||
Finally, <a href="-instigator/index.html">Instigator</a> sends the transaction containing all signatures back to each participant so they can record it and
|
||||
use the new updated state for future transactions.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-acceptor/index.html">Acceptor</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">Acceptor</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.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></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-handshake/index.html">Handshake</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Handshake</span> <span class="symbol">:</span> <a href="../../com.r3corda.protocols/-abstract-request-message/index.html"><span class="identifier">AbstractRequestMessage</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-instigator/index.html">Instigator</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">Instigator</span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">, </span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.protocols/-protocol-logic/index.html"><span class="identifier">ProtocolLogic</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-proposal/index.html">Proposal</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Proposal</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<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></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">AbstractStateReplacementProtocol</span><span class="symbol">(</span><span class="symbol">)</span></code><p>Abstract protocol to be used for replacing one state with another, for example when changing the notary of a state.
|
||||
Notably this requires a one to one replacement of states, states cannot be split, merged or issued as part of these
|
||||
protocols.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-notary-change-protocol/index.html">NotaryChangeProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">NotaryChangeProtocol</span> <span class="symbol">:</span> <span class="identifier">AbstractStateReplacementProtocol</span><span class="symbol"><</span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code><p>A protocol to be used for changing a states Notary. This is required since all input states to a transaction
|
||||
must point to the same notary.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Acceptor.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Acceptor</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Acceptor</span><span class="symbol">(</span><span class="identifier" id="protocols.NotaryChangeProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/sessionIdForSend">sessionIdForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/sessionIdForReceive">sessionIdForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/progressTracker">progressTracker</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a> <span class="symbol">=</span> tracker()<span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/-t-o-p-i-c_-c-h-a-n-g-e.html
vendored
Normal file
16
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/-t-o-p-i-c_-c-h-a-n-g-e.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Acceptor.TOPIC_CHANGE - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">TOPIC_CHANGE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_CHANGE</h1>
|
||||
<a name="protocols.NotaryChangeProtocol.Acceptor$TOPIC_CHANGE"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
Overrides <a href="../../-abstract-state-replacement-protocol/-acceptor/-t-o-p-i-c_-c-h-a-n-g-e.html">Acceptor.TOPIC_CHANGE</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/-t-o-p-i-c_-i-n-i-t-i-a-t-e.html
vendored
Normal file
16
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/-t-o-p-i-c_-i-n-i-t-i-a-t-e.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Acceptor.TOPIC_INITIATE - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">TOPIC_INITIATE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_INITIATE</h1>
|
||||
<a name="protocols.NotaryChangeProtocol.Acceptor$TOPIC_INITIATE"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
Overrides <a href="../../-abstract-state-replacement-protocol/-acceptor/-t-o-p-i-c_-i-n-i-t-i-a-t-e.html">Acceptor.TOPIC_INITIATE</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
87
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/index.html
vendored
Normal file
87
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/index.html
vendored
Normal file
@ -0,0 +1,87 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Acceptor - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href=".">Acceptor</a><br/>
|
||||
<br/>
|
||||
<h1>Acceptor</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Acceptor</span> <span class="symbol">:</span> <a href="../../-abstract-state-replacement-protocol/-acceptor/index.html"><span class="identifier">Acceptor</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</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">Acceptor</span><span class="symbol">(</span><span class="identifier" id="protocols.NotaryChangeProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/otherSide">otherSide</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/sessionIdForSend">sessionIdForSend</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/sessionIdForReceive">sessionIdForReceive</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Acceptor$<init>(com.r3corda.core.crypto.Party, kotlin.Long, kotlin.Long, com.r3corda.core.utilities.ProgressTracker)/progressTracker">progressTracker</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a> <span class="symbol">=</span> tracker()<span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-c-h-a-n-g-e.html">TOPIC_CHANGE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-i-n-i-t-i-a-t-e.html">TOPIC_INITIATE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="progress-tracker.html">progressTracker</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><p>Override this to provide a <a href="../../../com.r3corda.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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-abstract-state-replacement-protocol/-acceptor/other-side.html">otherSide</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">otherSide</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-abstract-state-replacement-protocol/-acceptor/session-id-for-receive.html">sessionIdForReceive</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionIdForReceive</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-abstract-state-replacement-protocol/-acceptor/session-id-for-send.html">sessionIdForSend</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">sessionIdForSend</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-abstract-state-replacement-protocol/-acceptor/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>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
24
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/progress-tracker.html
vendored
Normal file
24
docs/build/html/api/protocols/-notary-change-protocol/-acceptor/progress-tracker.html
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Acceptor.progressTracker - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Acceptor</a> / <a href=".">progressTracker</a><br/>
|
||||
<br/>
|
||||
<h1>progressTracker</h1>
|
||||
<a name="protocols.NotaryChangeProtocol.Acceptor$progressTracker"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">progressTracker</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><br/>
|
||||
Overrides <a href="../../-abstract-state-replacement-protocol/-acceptor/progress-tracker.html">Acceptor.progressTracker</a><br/>
|
||||
<p>Override this to provide a <a href="../../../com.r3corda.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>
|
||||
14
docs/build/html/api/protocols/-notary-change-protocol/-instigator/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-notary-change-protocol/-instigator/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Instigator.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Instigator</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Instigator</span><span class="symbol">(</span><span class="identifier" id="protocols.NotaryChangeProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.NotaryChangeProtocol.Instigator.T)), com.r3corda.core.crypto.Party, com.r3corda.core.utilities.ProgressTracker)/originalState">originalState</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.NotaryChangeProtocol.Instigator.T)), com.r3corda.core.crypto.Party, com.r3corda.core.utilities.ProgressTracker)/newNotary">newNotary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.NotaryChangeProtocol.Instigator.T)), com.r3corda.core.crypto.Party, com.r3corda.core.utilities.ProgressTracker)/progressTracker">progressTracker</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a> <span class="symbol">=</span> tracker()<span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-notary-change-protocol/-instigator/-t-o-p-i-c_-c-h-a-n-g-e.html
vendored
Normal file
16
docs/build/html/api/protocols/-notary-change-protocol/-instigator/-t-o-p-i-c_-c-h-a-n-g-e.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Instigator.TOPIC_CHANGE - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">TOPIC_CHANGE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_CHANGE</h1>
|
||||
<a name="protocols.NotaryChangeProtocol.Instigator$TOPIC_CHANGE"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
Overrides <a href="../../-abstract-state-replacement-protocol/-instigator/-t-o-p-i-c_-c-h-a-n-g-e.html">Instigator.TOPIC_CHANGE</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Instigator.TOPIC_INITIATE - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Instigator</a> / <a href=".">TOPIC_INITIATE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_INITIATE</h1>
|
||||
<a name="protocols.NotaryChangeProtocol.Instigator$TOPIC_INITIATE"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
Overrides <a href="../../-abstract-state-replacement-protocol/-instigator/-t-o-p-i-c_-i-n-i-t-i-a-t-e.html">Instigator.TOPIC_INITIATE</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
81
docs/build/html/api/protocols/-notary-change-protocol/-instigator/index.html
vendored
Normal file
81
docs/build/html/api/protocols/-notary-change-protocol/-instigator/index.html
vendored
Normal file
@ -0,0 +1,81 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Instigator - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href=".">Instigator</a><br/>
|
||||
<br/>
|
||||
<h1>Instigator</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Instigator</span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span> <span class="symbol">:</span> <a href="../../-abstract-state-replacement-protocol/-instigator/index.html"><span class="identifier">Instigator</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">,</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</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">Instigator</span><span class="symbol">(</span><span class="identifier" id="protocols.NotaryChangeProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.NotaryChangeProtocol.Instigator.T)), com.r3corda.core.crypto.Party, com.r3corda.core.utilities.ProgressTracker)/originalState">originalState</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.NotaryChangeProtocol.Instigator.T)), com.r3corda.core.crypto.Party, com.r3corda.core.utilities.ProgressTracker)/newNotary">newNotary</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Instigator$<init>(com.r3corda.core.contracts.StateAndRef((protocols.NotaryChangeProtocol.Instigator.T)), com.r3corda.core.crypto.Party, com.r3corda.core.utilities.ProgressTracker)/progressTracker">progressTracker</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a> <span class="symbol">=</span> tracker()<span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-c-h-a-n-g-e.html">TOPIC_CHANGE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-i-n-i-t-i-a-t-e.html">TOPIC_INITIATE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</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="../../-abstract-state-replacement-protocol/-instigator/modification.html">modification</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">modification</span><span class="symbol">: </span><span class="identifier">T</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-abstract-state-replacement-protocol/-instigator/original-state.html">originalState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">originalState</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-abstract-state-replacement-protocol/-instigator/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="../../../com.r3corda.core.utilities/-progress-tracker/index.html"><span class="identifier">ProgressTracker</span></a></code><p>Override this to provide a <a href="../../../com.r3corda.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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-abstract-state-replacement-protocol/-instigator/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="../../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span></code><p>This is where you fill out your business logic.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-notary-change-protocol/-proposal/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-notary-change-protocol/-proposal/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Proposal.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Proposal</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Proposal</span><span class="symbol">(</span><span class="identifier" id="protocols.NotaryChangeProtocol.Proposal$<init>(com.r3corda.core.contracts.StateRef, com.r3corda.core.crypto.Party, com.r3corda.core.contracts.SignedTransaction)/stateRef">stateRef</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Proposal$<init>(com.r3corda.core.contracts.StateRef, com.r3corda.core.crypto.Party, com.r3corda.core.contracts.SignedTransaction)/modification">modification</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Proposal$<init>(com.r3corda.core.contracts.StateRef, com.r3corda.core.crypto.Party, com.r3corda.core.contracts.SignedTransaction)/stx">stx</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
docs/build/html/api/protocols/-notary-change-protocol/-proposal/index.html
vendored
Normal file
48
docs/build/html/api/protocols/-notary-change-protocol/-proposal/index.html
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Proposal - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href=".">Proposal</a><br/>
|
||||
<br/>
|
||||
<h1>Proposal</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Proposal</span> <span class="symbol">:</span> <a href="../../-abstract-state-replacement-protocol/-proposal/index.html"><span class="identifier">Proposal</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</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">Proposal</span><span class="symbol">(</span><span class="identifier" id="protocols.NotaryChangeProtocol.Proposal$<init>(com.r3corda.core.contracts.StateRef, com.r3corda.core.crypto.Party, com.r3corda.core.contracts.SignedTransaction)/stateRef">stateRef</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Proposal$<init>(com.r3corda.core.contracts.StateRef, com.r3corda.core.crypto.Party, com.r3corda.core.contracts.SignedTransaction)/modification">modification</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.NotaryChangeProtocol.Proposal$<init>(com.r3corda.core.contracts.StateRef, com.r3corda.core.crypto.Party, com.r3corda.core.contracts.SignedTransaction)/stx">stx</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="modification.html">modification</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">modification</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="state-ref.html">stateRef</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">stateRef</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="stx.html">stx</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">stx</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-notary-change-protocol/-proposal/modification.html
vendored
Normal file
16
docs/build/html/api/protocols/-notary-change-protocol/-proposal/modification.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Proposal.modification - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Proposal</a> / <a href=".">modification</a><br/>
|
||||
<br/>
|
||||
<h1>modification</h1>
|
||||
<a name="protocols.NotaryChangeProtocol.Proposal$modification"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">modification</span><span class="symbol">: </span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><br/>
|
||||
Overrides <a href="../../-abstract-state-replacement-protocol/-proposal/modification.html">Proposal.modification</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-notary-change-protocol/-proposal/state-ref.html
vendored
Normal file
16
docs/build/html/api/protocols/-notary-change-protocol/-proposal/state-ref.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Proposal.stateRef - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Proposal</a> / <a href=".">stateRef</a><br/>
|
||||
<br/>
|
||||
<h1>stateRef</h1>
|
||||
<a name="protocols.NotaryChangeProtocol.Proposal$stateRef"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">stateRef</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a></code><br/>
|
||||
Overrides <a href="../../-abstract-state-replacement-protocol/-proposal/state-ref.html">Proposal.stateRef</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
16
docs/build/html/api/protocols/-notary-change-protocol/-proposal/stx.html
vendored
Normal file
16
docs/build/html/api/protocols/-notary-change-protocol/-proposal/stx.html
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.Proposal.stx - </title>
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../index.html">protocols</a> / <a href="../index.html">NotaryChangeProtocol</a> / <a href="index.html">Proposal</a> / <a href=".">stx</a><br/>
|
||||
<br/>
|
||||
<h1>stx</h1>
|
||||
<a name="protocols.NotaryChangeProtocol.Proposal$stx"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">stx</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a></code><br/>
|
||||
Overrides <a href="../../-abstract-state-replacement-protocol/-proposal/stx.html">Proposal.stx</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-notary-change-protocol/-t-o-p-i-c_-c-h-a-n-g-e.html
vendored
Normal file
15
docs/build/html/api/protocols/-notary-change-protocol/-t-o-p-i-c_-c-h-a-n-g-e.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.TOPIC_CHANGE - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">NotaryChangeProtocol</a> / <a href=".">TOPIC_CHANGE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_CHANGE</h1>
|
||||
<a name="protocols.NotaryChangeProtocol$TOPIC_CHANGE"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-notary-change-protocol/-t-o-p-i-c_-i-n-i-t-i-a-t-e.html
vendored
Normal file
15
docs/build/html/api/protocols/-notary-change-protocol/-t-o-p-i-c_-i-n-i-t-i-a-t-e.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol.TOPIC_INITIATE - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">NotaryChangeProtocol</a> / <a href=".">TOPIC_INITIATE</a><br/>
|
||||
<br/>
|
||||
<h1>TOPIC_INITIATE</h1>
|
||||
<a name="protocols.NotaryChangeProtocol$TOPIC_INITIATE"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
62
docs/build/html/api/protocols/-notary-change-protocol/index.html
vendored
Normal file
62
docs/build/html/api/protocols/-notary-change-protocol/index.html
vendored
Normal file
@ -0,0 +1,62 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>NotaryChangeProtocol - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">NotaryChangeProtocol</a><br/>
|
||||
<br/>
|
||||
<h1>NotaryChangeProtocol</h1>
|
||||
<code><span class="keyword">object </span><span class="identifier">NotaryChangeProtocol</span> <span class="symbol">:</span> <a href="../-abstract-state-replacement-protocol/index.html"><span class="identifier">AbstractStateReplacementProtocol</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code><br/>
|
||||
<p>A protocol to be used for changing a states Notary. This is required since all input states to a transaction
|
||||
must point to the same notary.</p>
|
||||
<p>The <a href="-instigator/index.html">Instigator</a> assembles the transaction for notary replacement and sends out change proposals to all participants
|
||||
(<a href="-acceptor/index.html">Acceptor</a>) of that state. If participants agree to the proposed change, they each sign the transaction.
|
||||
Finally, <a href="-instigator/index.html">Instigator</a> sends the transaction containing all signatures back to each participant so they can record it and
|
||||
use the new updated state for future transactions.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-acceptor/index.html">Acceptor</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Acceptor</span> <span class="symbol">:</span> <a href="../-abstract-state-replacement-protocol/-acceptor/index.html"><span class="identifier">Acceptor</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-instigator/index.html">Instigator</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Instigator</span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span> <span class="symbol">:</span> <a href="../-abstract-state-replacement-protocol/-instigator/index.html"><span class="identifier">Instigator</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">,</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-proposal/index.html">Proposal</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Proposal</span> <span class="symbol">:</span> <a href="../-abstract-state-replacement-protocol/-proposal/index.html"><span class="identifier">Proposal</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-c-h-a-n-g-e.html">TOPIC_CHANGE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_CHANGE</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-t-o-p-i-c_-i-n-i-t-i-a-t-e.html">TOPIC_INITIATE</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">TOPIC_INITIATE</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
14
docs/build/html/api/protocols/-state-replacement-exception/-init-.html
vendored
Normal file
14
docs/build/html/api/protocols/-state-replacement-exception/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementException.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">StateReplacementException</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">StateReplacementException</span><span class="symbol">(</span><span class="identifier" id="protocols.StateReplacementException$<init>(protocols.StateReplacementRefused)/error">error</span><span class="symbol">:</span> <a href="../-state-replacement-refused/index.html"><span class="identifier">StateReplacementRefused</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-state-replacement-exception/error.html
vendored
Normal file
15
docs/build/html/api/protocols/-state-replacement-exception/error.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementException.error - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">StateReplacementException</a> / <a href=".">error</a><br/>
|
||||
<br/>
|
||||
<h1>error</h1>
|
||||
<a name="protocols.StateReplacementException$error"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="../-state-replacement-refused/index.html"><span class="identifier">StateReplacementRefused</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
docs/build/html/api/protocols/-state-replacement-exception/index.html
vendored
Normal file
36
docs/build/html/api/protocols/-state-replacement-exception/index.html
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementException - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">StateReplacementException</a><br/>
|
||||
<br/>
|
||||
<h1>StateReplacementException</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">StateReplacementException</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">StateReplacementException</span><span class="symbol">(</span><span class="identifier" id="protocols.StateReplacementException$<init>(protocols.StateReplacementRefused)/error">error</span><span class="symbol">:</span> <a href="../-state-replacement-refused/index.html"><span class="identifier">StateReplacementRefused</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="error.html">error</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="../-state-replacement-refused/index.html"><span class="identifier">StateReplacementRefused</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-state-replacement-refused/-init-.html
vendored
Normal file
15
docs/build/html/api/protocols/-state-replacement-refused/-init-.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementRefused.<init> - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">StateReplacementRefused</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">StateReplacementRefused</span><span class="symbol">(</span><span class="identifier" id="protocols.StateReplacementRefused$<init>(com.r3corda.core.crypto.Party, com.r3corda.core.contracts.StateRef, kotlin.String)/identity">identity</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.StateReplacementRefused$<init>(com.r3corda.core.crypto.Party, com.r3corda.core.contracts.StateRef, kotlin.String)/state">state</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">, </span><span class="identifier" id="protocols.StateReplacementRefused$<init>(com.r3corda.core.crypto.Party, com.r3corda.core.contracts.StateRef, kotlin.String)/detail">detail</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">?</span><span class="symbol">)</span></code><br/>
|
||||
<p>Thrown when a participant refuses proposed the state replacement</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-state-replacement-refused/detail.html
vendored
Normal file
15
docs/build/html/api/protocols/-state-replacement-refused/detail.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementRefused.detail - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">StateReplacementRefused</a> / <a href=".">detail</a><br/>
|
||||
<br/>
|
||||
<h1>detail</h1>
|
||||
<a name="protocols.StateReplacementRefused$detail"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">detail</span><span class="symbol">: </span><span class="identifier">String</span><span class="symbol">?</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-state-replacement-refused/identity.html
vendored
Normal file
15
docs/build/html/api/protocols/-state-replacement-refused/identity.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementRefused.identity - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">StateReplacementRefused</a> / <a href=".">identity</a><br/>
|
||||
<br/>
|
||||
<h1>identity</h1>
|
||||
<a name="protocols.StateReplacementRefused$identity"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">identity</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
61
docs/build/html/api/protocols/-state-replacement-refused/index.html
vendored
Normal file
61
docs/build/html/api/protocols/-state-replacement-refused/index.html
vendored
Normal file
@ -0,0 +1,61 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementRefused - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href=".">StateReplacementRefused</a><br/>
|
||||
<br/>
|
||||
<h1>StateReplacementRefused</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">StateReplacementRefused</span></code><br/>
|
||||
<p>Thrown when a participant refuses proposed the state replacement</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">StateReplacementRefused</span><span class="symbol">(</span><span class="identifier" id="protocols.StateReplacementRefused$<init>(com.r3corda.core.crypto.Party, com.r3corda.core.contracts.StateRef, kotlin.String)/identity">identity</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="protocols.StateReplacementRefused$<init>(com.r3corda.core.crypto.Party, com.r3corda.core.contracts.StateRef, kotlin.String)/state">state</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">, </span><span class="identifier" id="protocols.StateReplacementRefused$<init>(com.r3corda.core.crypto.Party, com.r3corda.core.contracts.StateRef, kotlin.String)/detail">detail</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">?</span><span class="symbol">)</span></code><p>Thrown when a participant refuses proposed the state replacement</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="detail.html">detail</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">detail</span><span class="symbol">: </span><span class="identifier">String</span><span class="symbol">?</span></code></td>
|
||||
</tr>
|
||||
<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="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="state.html">state</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">state</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a></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/-state-replacement-refused/state.html
vendored
Normal file
15
docs/build/html/api/protocols/-state-replacement-refused/state.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementRefused.state - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">StateReplacementRefused</a> / <a href=".">state</a><br/>
|
||||
<br/>
|
||||
<h1>state</h1>
|
||||
<a name="protocols.StateReplacementRefused$state"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">state</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-state-ref/index.html"><span class="identifier">StateRef</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/protocols/-state-replacement-refused/to-string.html
vendored
Normal file
15
docs/build/html/api/protocols/-state-replacement-refused/to-string.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>StateReplacementRefused.toString - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">protocols</a> / <a href="index.html">StateReplacementRefused</a> / <a href=".">toString</a><br/>
|
||||
<br/>
|
||||
<h1>toString</h1>
|
||||
<a name="protocols.StateReplacementRefused$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>
|
||||
51
docs/build/html/api/protocols/index.html
vendored
Normal file
51
docs/build/html/api/protocols/index.html
vendored
Normal file
@ -0,0 +1,51 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>protocols - </title>
|
||||
<link rel="stylesheet" href="../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href=".">protocols</a><br/>
|
||||
<br/>
|
||||
<h2>Package protocols</h2>
|
||||
<h3>Types</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-abstract-state-replacement-protocol/index.html">AbstractStateReplacementProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">AbstractStateReplacementProtocol</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><p>Abstract protocol to be used for replacing one state with another, for example when changing the notary of a state.
|
||||
Notably this requires a one to one replacement of states, states cannot be split, merged or issued as part of these
|
||||
protocols.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-notary-change-protocol/index.html">NotaryChangeProtocol</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">object </span><span class="identifier">NotaryChangeProtocol</span> <span class="symbol">:</span> <a href="-abstract-state-replacement-protocol/index.html"><span class="identifier">AbstractStateReplacementProtocol</span></a><span class="symbol"><</span><a href="../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code><p>A protocol to be used for changing a states Notary. This is required since all input states to a transaction
|
||||
must point to the same notary.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state-replacement-refused/index.html">StateReplacementRefused</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">StateReplacementRefused</span></code><p>Thrown when a participant refuses proposed the state replacement</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Exceptions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state-replacement-exception/index.html">StateReplacementException</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">StateReplacementException</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>
|
||||
</BODY>
|
||||
</HTML>
|
||||
Reference in New Issue
Block a user