352 lines
7.5 KiB
HTML
352 lines
7.5 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='UTF-8'>
|
|
<title>CoffeeScript API Documentation</title>
|
|
<script src='../javascript/application.js'></script>
|
|
<script src='../javascript/search.js'></script>
|
|
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
|
|
</head>
|
|
<body>
|
|
<div id='base' data-path='../'></div>
|
|
<div id='header'>
|
|
<div id='menu'>
|
|
<a href='../extra/README.md.html' title='Yatta'>
|
|
Yatta
|
|
</a>
|
|
»
|
|
<a href='../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>TestConnector</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
TestConnector
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>lib/Connectors/TestConnector.coffee</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>A trivial Connector that simulates network delay.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#getOpsInExecutionOrder-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getOpsInExecutionOrder</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
This engine applied operations in a specific order.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#send-dynamic'>
|
|
#
|
|
(void)
|
|
<b>send</b><span>(o)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
This function is called whenever an operation was executed.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#receive-dynamic'>
|
|
#
|
|
(void)
|
|
<b>receive</b><span>(o)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
This function is called whenever an operation was received from another peer.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#flushOne-dynamic'>
|
|
#
|
|
(void)
|
|
<b>flushOne</b><span>(user)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Flush one operation from the line of a specific user.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#flushOneRandom-dynamic'>
|
|
#
|
|
(void)
|
|
<b>flushOneRandom</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Flush one operation on a random line.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#flushAll-dynamic'>
|
|
#
|
|
(void)
|
|
<b>flushAll</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Flush all operations on every line.
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Constructor Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='constructor-dynamic'>
|
|
#
|
|
(void)
|
|
<b>constructor</b><span>(engine, HB, execution_listener)</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>engine</span>
|
|
<span class='type'>
|
|
(
|
|
<tt><a href='../class/Engine.html'>Engine</a></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The transformation engine </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>HB</span>
|
|
<span class='type'>
|
|
(
|
|
<tt><a href='../class/HistoryBuffer.html'>HistoryBuffer</a></tt>
|
|
)
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>execution_listener</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Array<Function></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>You must ensure that whenever an operation is executed, every function in this Array is called. </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>yatta</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Yatta</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The Yatta framework. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='getOpsInExecutionOrder-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getOpsInExecutionOrder</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>This engine applied operations in a specific order.
|
|
Get the ops in the right order.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='send-dynamic'>
|
|
#
|
|
(void)
|
|
<b>send</b><span>(o)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>This function is called whenever an operation was executed.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>o</span>
|
|
<span class='type'>
|
|
(
|
|
<tt><a href='../class/Operation.html'>Operation</a></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The operation that was executed. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='receive-dynamic'>
|
|
#
|
|
(void)
|
|
<b>receive</b><span>(o)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>This function is called whenever an operation was received from another peer.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>o</span>
|
|
<span class='type'>
|
|
(
|
|
<tt><a href='../class/Operation.html'>Operation</a></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The operation that was received. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='flushOne-dynamic'>
|
|
#
|
|
(void)
|
|
<b>flushOne</b><span>(user)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Flush one operation from the line of a specific user.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='flushOneRandom-dynamic'>
|
|
#
|
|
(void)
|
|
<b>flushOneRandom</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Flush one operation on a random line.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='flushAll-dynamic'>
|
|
#
|
|
(void)
|
|
<b>flushAll</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Flush all operations on every line.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
August 12, 14 06:33:02 by
|
|
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
|
Codo
|
|
</a>
|
|
2.0.9
|
|
✲
|
|
Press H to see the keyboard shortcuts
|
|
✲
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
|
✲
|
|
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
|
|
</div>
|
|
<iframe id='search_frame'></iframe>
|
|
<div id='fuzzySearch'>
|
|
<input type='text'>
|
|
<ol></ol>
|
|
</div>
|
|
<div id='help'>
|
|
<p>
|
|
Quickly fuzzy find classes, mixins, methods, file:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>T</span>
|
|
Open fuzzy finder dialog
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
Control the navigation frame:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>L</span>
|
|
Toggle list view
|
|
</li>
|
|
<li>
|
|
<span>C</span>
|
|
Show class list
|
|
</li>
|
|
<li>
|
|
<span>I</span>
|
|
Show mixin list
|
|
</li>
|
|
<li>
|
|
<span>F</span>
|
|
Show file list
|
|
</li>
|
|
<li>
|
|
<span>M</span>
|
|
Show method list
|
|
</li>
|
|
<li>
|
|
<span>E</span>
|
|
Show extras list
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
You can focus and blur the search input:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>S</span>
|
|
Focus search input
|
|
</li>
|
|
<li>
|
|
<span>Esc</span>
|
|
Blur search input
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html> |