106 lines
4.3 KiB
HTML
106 lines
4.3 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_dt</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_dt</h1>
|
|
<ul class="index"><li><a href="#types">Data Types</a></li></ul>
|
|
|
|
|
|
<h2><a name="types">Data Types</a></h2>
|
|
|
|
<h3 class="typedecl"><a name="type-chunk">chunk()</a></h3>
|
|
<p><tt>chunk() = <a href="#type-chunk_bin">chunk_bin()</a> | {<a href="#type-chunk_csum">chunk_csum()</a>, <a href="#type-chunk_bin">chunk_bin()</a>}</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-chunk_bin">chunk_bin()</a></h3>
|
|
<p><tt>chunk_bin() = binary() | iolist()</tt></p>
|
|
<p> client can use either</p>
|
|
|
|
<h3 class="typedecl"><a name="type-chunk_csum">chunk_csum()</a></h3>
|
|
<p><tt>chunk_csum() = binary()</tt></p>
|
|
<p> 1 byte tag, N-1 bytes checksum</p>
|
|
|
|
<h3 class="typedecl"><a name="type-chunk_pos">chunk_pos()</a></h3>
|
|
<p><tt>chunk_pos() = {<a href="#type-file_offset">file_offset()</a>, <a href="#type-chunk_size">chunk_size()</a>, <a href="#type-file_name_s">file_name_s()</a>}</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-chunk_s">chunk_s()</a></h3>
|
|
<p><tt>chunk_s() = binary()</tt></p>
|
|
<p> server always uses binary()</p>
|
|
|
|
<h3 class="typedecl"><a name="type-chunk_size">chunk_size()</a></h3>
|
|
<p><tt>chunk_size() = non_neg_integer()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-chunk_summary">chunk_summary()</a></h3>
|
|
<p><tt>chunk_summary() = {<a href="#type-file_offset">file_offset()</a>, <a href="#type-chunk_size">chunk_size()</a>, binary()}</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-epoch_csum">epoch_csum()</a></h3>
|
|
<p><tt>epoch_csum() = binary()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-epoch_id">epoch_id()</a></h3>
|
|
<p><tt>epoch_id() = {<a href="#type-epoch_num">epoch_num()</a>, <a href="#type-epoch_csum">epoch_csum()</a>}</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-epoch_num">epoch_num()</a></h3>
|
|
<p><tt>epoch_num() = -1 | non_neg_integer()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-error_general">error_general()</a></h3>
|
|
<p><tt>error_general() = bad_arg | wedged | bad_checksum</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-file_info">file_info()</a></h3>
|
|
<p><tt>file_info() = {<a href="#type-file_size">file_size()</a>, <a href="#type-file_name_s">file_name_s()</a>}</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-file_name">file_name()</a></h3>
|
|
<p><tt>file_name() = binary() | list()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-file_name_s">file_name_s()</a></h3>
|
|
<p><tt>file_name_s() = binary()</tt></p>
|
|
<p> server reply</p>
|
|
|
|
<h3 class="typedecl"><a name="type-file_offset">file_offset()</a></h3>
|
|
<p><tt>file_offset() = non_neg_integer()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-file_prefix">file_prefix()</a></h3>
|
|
<p><tt>file_prefix() = binary() | list()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-file_size">file_size()</a></h3>
|
|
<p><tt>file_size() = non_neg_integer()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-inet_host">inet_host()</a></h3>
|
|
<p><tt>inet_host() = <a href="inet.html#type-ip_address">inet:ip_address()</a> | <a href="inet.html#type-hostname">inet:hostname()</a></tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-inet_port">inet_port()</a></h3>
|
|
<p><tt>inet_port() = <a href="inet.html#type-port_number">inet:port_number()</a></tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-projection">projection()</a></h3>
|
|
<p><tt>projection() = #projection_v1{}</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-projection_type">projection_type()</a></h3>
|
|
<p><tt>projection_type() = public | private</tt></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>
|