2015-06-25 07:40:14 +00:00
|
|
|
<!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_pb_high_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_pb_high_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>Machi PB (Protocol Buffers) high-level client (prototype, API TBD).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2><a name="description">Description</a></h2><p>Machi PB (Protocol Buffers) high-level client (prototype, API TBD)</p>
|
|
|
|
|
|
|
|
|
|
At the moment, this is brittle-prototype-quality code: the API is not yet
|
|
|
|
|
fully specified, there is very little error handling with respect
|
|
|
|
|
to a single socket connection, and there is no code to deal with
|
|
|
|
|
multiple connections/load balancing/error handling to several/all
|
|
|
|
|
Machi cluster servers.
|
|
|
|
|
<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-6">append_chunk/6</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#append_chunk-7">append_chunk/7</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#auth-3">auth/3</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#auth-4">auth/4</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#checksum_list-2">checksum_list/2</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#checksum_list-3">checksum_list/3</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#code_change-3">code_change/3</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="#convert_general_status_code-1">convert_general_status_code/1</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#echo-2">echo/2</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#echo-3">echo/3</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#list_files-1">list_files/1</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#list_files-2">list_files/2</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#quit-1">quit/1</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#read_chunk-4">read_chunk/4</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#read_chunk-5">read_chunk/5</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#write_chunk-5">write_chunk/5</a></td><td></td></tr>
|
|
|
|
|
<tr><td valign="top"><a href="#write_chunk-6">write_chunk/6</a></td><td></td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h2><a name="functions">Function Details</a></h2>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="append_chunk-6">append_chunk/6</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>append_chunk(PidSpec, PlacementKey, Prefix, Chunk, CSum, ChunkExtra) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="append_chunk-7">append_chunk/7</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>append_chunk(PidSpec, PlacementKey, Prefix, Chunk, CSum, ChunkExtra, Timeout) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="auth-3">auth/3</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>auth(PidSpec, User, Pass) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="auth-4">auth/4</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>auth(PidSpec, User, Pass, Timeout) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="checksum_list-2">checksum_list/2</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>checksum_list(PidSpec, File) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="checksum_list-3">checksum_list/3</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>checksum_list(PidSpec, File, Timeout) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="code_change-3">code_change/3</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>code_change(OldVsn, S, Extra) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="connected_p-1">connected_p/1</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>connected_p(PidSpec) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="convert_general_status_code-1">convert_general_status_code/1</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>convert_general_status_code(X1) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="echo-2">echo/2</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>echo(PidSpec, String) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="echo-3">echo/3</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>echo(PidSpec, String, Timeout) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>handle_call(Request, From, S) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>handle_cast(Msg, S) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>handle_info(Info, S) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="init-1">init/1</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>init(X1) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="list_files-1">list_files/1</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>list_files(PidSpec) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="list_files-2">list_files/2</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>list_files(PidSpec, Timeout) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="quit-1">quit/1</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>quit(PidSpec) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="read_chunk-4">read_chunk/4</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>read_chunk(PidSpec, File, Offset, Size) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="read_chunk-5">read_chunk/5</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>read_chunk(PidSpec, File, Offset, Size, Timeout) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="start_link-1">start_link/1</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>start_link(P_srvr_list) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="terminate-2">terminate/2</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>terminate(Reason, S) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="write_chunk-5">write_chunk/5</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>write_chunk(PidSpec, File, Offset, Chunk, CSum) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="function"><a name="write_chunk-6">write_chunk/6</a></h3>
|
|
|
|
|
<div class="spec">
|
|
|
|
|
<p><tt>write_chunk(PidSpec, File, Offset, Chunk, CSum, Timeout) -> any()</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
<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>
|
2015-07-01 09:33:21 +00:00
|
|
|
<p><i>Generated by EDoc, Jul 1 2015, 18:32:19.</i></p>
|
2015-06-25 07:40:14 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
