260 lines
15 KiB
HTML
260 lines
15 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>Module machi_yessir_client</title>
|
|
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
|
|
</head>
|
|
<body bgcolor="white">
|
|
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
|
|
<hr>
|
|
|
|
<h1>Module machi_yessir_client</h1>
|
|
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>"Yes, sir!" style dummy/mock client facade.
|
|
|
|
|
|
<h2><a name="description">Description</a></h2>"Yes, sir!" style dummy/mock client facade.
|
|
<h2><a name="index">Function Index</a></h2>
|
|
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#append_chunk-4">append_chunk/4</a></td><td>Append a chunk (binary- or iolist-style) of data to a file
|
|
with <code>Prefix</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#append_chunk-5">append_chunk/5</a></td><td>Append a chunk (binary- or iolist-style) of data to a file
|
|
with <code>Prefix</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#append_chunk_extra-5">append_chunk_extra/5</a></td><td>Append a chunk (binary- or iolist-style) of data to a file
|
|
with <code>Prefix</code> and also request an additional <code>Extra</code> bytes.</td></tr>
|
|
<tr><td valign="top"><a href="#append_chunk_extra-6">append_chunk_extra/6</a></td><td>Append a chunk (binary- or iolist-style) of data to a file
|
|
with <code>Prefix</code> and also request an additional <code>Extra</code> bytes.</td></tr>
|
|
<tr><td valign="top"><a href="#checksum_list-3">checksum_list/3</a></td><td>Fetch the list of chunk checksums for <code>File</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#checksum_list-4">checksum_list/4</a></td><td>Fetch the list of chunk checksums for <code>File</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#connect-1">connect/1</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#connected_p-1">connected_p/1</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#delete_migration-3">delete_migration/3</a></td><td>Restricted API: Delete a file after it has been successfully
|
|
migrated.</td></tr>
|
|
<tr><td valign="top"><a href="#delete_migration-4">delete_migration/4</a></td><td>Restricted API: Delete a file after it has been successfully
|
|
migrated.</td></tr>
|
|
<tr><td valign="top"><a href="#disconnect-1">disconnect/1</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#get_all_projections-2">get_all_projections/2</a></td><td>Get all projections from the FLU's projection store.</td></tr>
|
|
<tr><td valign="top"><a href="#get_all_projections-3">get_all_projections/3</a></td><td>Get all projections from the FLU's projection store.</td></tr>
|
|
<tr><td valign="top"><a href="#get_latest_epoch-2">get_latest_epoch/2</a></td><td>Get the latest epoch number + checksum from the FLU's projection store.</td></tr>
|
|
<tr><td valign="top"><a href="#get_latest_epoch-3">get_latest_epoch/3</a></td><td>Get the latest epoch number + checksum from the FLU's projection store.</td></tr>
|
|
<tr><td valign="top"><a href="#list_all_projections-2">list_all_projections/2</a></td><td>Get all epoch numbers from the FLU's projection store.</td></tr>
|
|
<tr><td valign="top"><a href="#list_all_projections-3">list_all_projections/3</a></td><td>Get all epoch numbers from the FLU's projection store.</td></tr>
|
|
<tr><td valign="top"><a href="#list_files-2">list_files/2</a></td><td>Fetch the list of all files on the remote FLU.</td></tr>
|
|
<tr><td valign="top"><a href="#list_files-3">list_files/3</a></td><td>Fetch the list of all files on the remote FLU.</td></tr>
|
|
<tr><td valign="top"><a href="#quit-1">quit/1</a></td><td>Quit & close the connection to remote FLU.</td></tr>
|
|
<tr><td valign="top"><a href="#read_chunk-5">read_chunk/5</a></td><td>Read a chunk of data of size <code>Size</code> from <code>File</code> at <code>Offset</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#read_chunk-6">read_chunk/6</a></td><td>Read a chunk of data of size <code>Size</code> from <code>File</code> at <code>Offset</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#read_latest_projection-2">read_latest_projection/2</a></td><td>Get the latest projection from the FLU's projection store for <code>ProjType</code></td></tr>
|
|
<tr><td valign="top"><a href="#read_latest_projection-3">read_latest_projection/3</a></td><td>Get the latest projection from the FLU's projection store for <code>ProjType</code></td></tr>
|
|
<tr><td valign="top"><a href="#read_projection-3">read_projection/3</a></td><td>Read a projection <code>Proj</code> of type <code>ProjType</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#read_projection-4">read_projection/4</a></td><td>Read a projection <code>Proj</code> of type <code>ProjType</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#trunc_hack-3">trunc_hack/3</a></td><td>Restricted API: Truncate a file after it has been successfully
|
|
erasure coded.</td></tr>
|
|
<tr><td valign="top"><a href="#trunc_hack-4">trunc_hack/4</a></td><td>Restricted API: Truncate a file after it has been successfully
|
|
erasure coded.</td></tr>
|
|
<tr><td valign="top"><a href="#wedge_status-1">wedge_status/1</a></td><td>Fetch the wedge status from the remote FLU.</td></tr>
|
|
<tr><td valign="top"><a href="#wedge_status-2">wedge_status/2</a></td><td>Fetch the wedge status from the remote FLU.</td></tr>
|
|
<tr><td valign="top"><a href="#write_chunk-5">write_chunk/5</a></td><td>Restricted API: Write a chunk of already-sequenced data to
|
|
<code>File</code> at <code>Offset</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#write_chunk-6">write_chunk/6</a></td><td>Restricted API: Write a chunk of already-sequenced data to
|
|
<code>File</code> at <code>Offset</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#write_projection-3">write_projection/3</a></td><td>Write a projection <code>Proj</code> of type <code>ProjType</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#write_projection-4">write_projection/4</a></td><td>Write a projection <code>Proj</code> of type <code>ProjType</code>.</td></tr>
|
|
</table>
|
|
|
|
<h2><a name="functions">Function Details</a></h2>
|
|
|
|
<h3 class="function"><a name="append_chunk-4">append_chunk/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>append_chunk(Sock, EpochID, Prefix, Chunk) -> any()</tt></p>
|
|
</div><p>Append a chunk (binary- or iolist-style) of data to a file
|
|
with <code>Prefix</code>.</p>
|
|
|
|
<h3 class="function"><a name="append_chunk-5">append_chunk/5</a></h3>
|
|
<div class="spec">
|
|
<p><tt>append_chunk(Host, TcpPort, EpochID, Prefix, Chunk) -> any()</tt></p>
|
|
</div><p>Append a chunk (binary- or iolist-style) of data to a file
|
|
with <code>Prefix</code>.</p>
|
|
|
|
<h3 class="function"><a name="append_chunk_extra-5">append_chunk_extra/5</a></h3>
|
|
<div class="spec">
|
|
<p><tt>append_chunk_extra(Yessir, EpochID, Prefix, Chunk, ChunkExtra) -> any()</tt></p>
|
|
</div><p><p>Append a chunk (binary- or iolist-style) of data to a file
|
|
with <code>Prefix</code> and also request an additional <code>Extra</code> bytes.</p>
|
|
|
|
For example, if the <code>Chunk</code> size is 1 KByte and <code>Extra</code> is 4K Bytes, then
|
|
the file offsets that follow <code>Chunk</code>'s position for the following 4K will
|
|
be reserved by the file sequencer for later write(s) by the
|
|
<code>write_chunk()</code> API.</p>
|
|
|
|
<h3 class="function"><a name="append_chunk_extra-6">append_chunk_extra/6</a></h3>
|
|
<div class="spec">
|
|
<p><tt>append_chunk_extra(Host, TcpPort, EpochID, Prefix, Chunk, ChunkExtra) -> any()</tt></p>
|
|
</div><p><p>Append a chunk (binary- or iolist-style) of data to a file
|
|
with <code>Prefix</code> and also request an additional <code>Extra</code> bytes.</p>
|
|
|
|
For example, if the <code>Chunk</code> size is 1 KByte and <code>Extra</code> is 4K Bytes, then
|
|
the file offsets that follow <code>Chunk</code>'s position for the following 4K will
|
|
be reserved by the file sequencer for later write(s) by the
|
|
<code>write_chunk()</code> API.</p>
|
|
|
|
<h3 class="function"><a name="checksum_list-3">checksum_list/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>checksum_list(Yessir, EpochID, File) -> any()</tt></p>
|
|
</div><p>Fetch the list of chunk checksums for <code>File</code>.</p>
|
|
|
|
<h3 class="function"><a name="checksum_list-4">checksum_list/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>checksum_list(Host, TcpPort, EpochID, File) -> any()</tt></p>
|
|
</div><p>Fetch the list of chunk checksums for <code>File</code>.</p>
|
|
|
|
<h3 class="function"><a name="connect-1">connect/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>connect(P_srvr) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="connected_p-1">connected_p/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>connected_p(X1) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="delete_migration-3">delete_migration/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>delete_migration(Yessir, EpochID, File) -> any()</tt></p>
|
|
</div><p>Restricted API: Delete a file after it has been successfully
|
|
migrated.</p>
|
|
|
|
<h3 class="function"><a name="delete_migration-4">delete_migration/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>delete_migration(Host, TcpPort, EpochID, File) -> any()</tt></p>
|
|
</div><p>Restricted API: Delete a file after it has been successfully
|
|
migrated.</p>
|
|
|
|
<h3 class="function"><a name="disconnect-1">disconnect/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>disconnect(Yessir) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="get_all_projections-2">get_all_projections/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>get_all_projections(Yessir, ProjType) -> any()</tt></p>
|
|
</div><p>Get all projections from the FLU's projection store.</p>
|
|
|
|
<h3 class="function"><a name="get_all_projections-3">get_all_projections/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>get_all_projections(Host, TcpPort, ProjType) -> any()</tt></p>
|
|
</div><p>Get all projections from the FLU's projection store.</p>
|
|
|
|
<h3 class="function"><a name="get_latest_epoch-2">get_latest_epoch/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>get_latest_epoch(Sock, ProjType) -> any()</tt></p>
|
|
</div><p>Get the latest epoch number + checksum from the FLU's projection store.</p>
|
|
|
|
<h3 class="function"><a name="get_latest_epoch-3">get_latest_epoch/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>get_latest_epoch(Host, TcpPort, ProjType) -> any()</tt></p>
|
|
</div><p>Get the latest epoch number + checksum from the FLU's projection store.</p>
|
|
|
|
<h3 class="function"><a name="list_all_projections-2">list_all_projections/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>list_all_projections(Sock, ProjType) -> any()</tt></p>
|
|
</div><p>Get all epoch numbers from the FLU's projection store.</p>
|
|
|
|
<h3 class="function"><a name="list_all_projections-3">list_all_projections/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>list_all_projections(Host, TcpPort, ProjType) -> any()</tt></p>
|
|
</div><p>Get all epoch numbers from the FLU's projection store.</p>
|
|
|
|
<h3 class="function"><a name="list_files-2">list_files/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>list_files(Yessir, EpochID) -> any()</tt></p>
|
|
</div><p>Fetch the list of all files on the remote FLU.</p>
|
|
|
|
<h3 class="function"><a name="list_files-3">list_files/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>list_files(Host, TcpPort, EpochID) -> any()</tt></p>
|
|
</div><p>Fetch the list of all files on the remote FLU.</p>
|
|
|
|
<h3 class="function"><a name="quit-1">quit/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>quit(X1) -> any()</tt></p>
|
|
</div><p>Quit & close the connection to remote FLU.</p>
|
|
|
|
<h3 class="function"><a name="read_chunk-5">read_chunk/5</a></h3>
|
|
<div class="spec">
|
|
<p><tt>read_chunk(Yessir, EpochID, File, Offset, Size) -> any()</tt></p>
|
|
</div><p>Read a chunk of data of size <code>Size</code> from <code>File</code> at <code>Offset</code>.</p>
|
|
|
|
<h3 class="function"><a name="read_chunk-6">read_chunk/6</a></h3>
|
|
<div class="spec">
|
|
<p><tt>read_chunk(Host, TcpPort, EpochID, File, Offset, Size) -> any()</tt></p>
|
|
</div><p>Read a chunk of data of size <code>Size</code> from <code>File</code> at <code>Offset</code>.</p>
|
|
|
|
<h3 class="function"><a name="read_latest_projection-2">read_latest_projection/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>read_latest_projection(Yessir, ProjType) -> any()</tt></p>
|
|
</div><p>Get the latest projection from the FLU's projection store for <code>ProjType</code></p>
|
|
|
|
<h3 class="function"><a name="read_latest_projection-3">read_latest_projection/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>read_latest_projection(Host, TcpPort, ProjType) -> any()</tt></p>
|
|
</div><p>Get the latest projection from the FLU's projection store for <code>ProjType</code></p>
|
|
|
|
<h3 class="function"><a name="read_projection-3">read_projection/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>read_projection(Yessir, ProjType, Epoch) -> any()</tt></p>
|
|
</div><p>Read a projection <code>Proj</code> of type <code>ProjType</code>.</p>
|
|
|
|
<h3 class="function"><a name="read_projection-4">read_projection/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>read_projection(Host, TcpPort, ProjType, Epoch) -> any()</tt></p>
|
|
</div><p>Read a projection <code>Proj</code> of type <code>ProjType</code>.</p>
|
|
|
|
<h3 class="function"><a name="trunc_hack-3">trunc_hack/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>trunc_hack(Yessir, EpochID, File) -> any()</tt></p>
|
|
</div><p>Restricted API: Truncate a file after it has been successfully
|
|
erasure coded.</p>
|
|
|
|
<h3 class="function"><a name="trunc_hack-4">trunc_hack/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>trunc_hack(Host, TcpPort, EpochID, File) -> any()</tt></p>
|
|
</div><p>Restricted API: Truncate a file after it has been successfully
|
|
erasure coded.</p>
|
|
|
|
<h3 class="function"><a name="wedge_status-1">wedge_status/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>wedge_status(Sock) -> any()</tt></p>
|
|
</div><p>Fetch the wedge status from the remote FLU.</p>
|
|
|
|
<h3 class="function"><a name="wedge_status-2">wedge_status/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>wedge_status(Host, TcpPort) -> any()</tt></p>
|
|
</div><p>Fetch the wedge status from the remote FLU.</p>
|
|
|
|
<h3 class="function"><a name="write_chunk-5">write_chunk/5</a></h3>
|
|
<div class="spec">
|
|
<p><tt>write_chunk(Yessir, EpochID, File, Offset, Chunk) -> any()</tt></p>
|
|
</div><p>Restricted API: Write a chunk of already-sequenced data to
|
|
<code>File</code> at <code>Offset</code>.</p>
|
|
|
|
<h3 class="function"><a name="write_chunk-6">write_chunk/6</a></h3>
|
|
<div class="spec">
|
|
<p><tt>write_chunk(Host, TcpPort, EpochID, File, Offset, Chunk) -> any()</tt></p>
|
|
</div><p>Restricted API: Write a chunk of already-sequenced data to
|
|
<code>File</code> at <code>Offset</code>.</p>
|
|
|
|
<h3 class="function"><a name="write_projection-3">write_projection/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>write_projection(Yessir, ProjType, Proj) -> any()</tt></p>
|
|
</div><p>Write a projection <code>Proj</code> of type <code>ProjType</code>.</p>
|
|
|
|
<h3 class="function"><a name="write_projection-4">write_projection/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>write_projection(Host, TcpPort, ProjType, Proj) -> any()</tt></p>
|
|
</div><p>Write a projection <code>Proj</code> of type <code>ProjType</code>.</p>
|
|
<hr>
|
|
|
|
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
|
|
<p><i>Generated by EDoc, Jul 1 2015, 18:32:19.</i></p>
|
|
</body>
|
|
</html>
|