Current section
Files
Jump to
Current section
Files
doc/cloudi_service_filesystem.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 cloudi_service_filesystem</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 cloudi_service_filesystem</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>
<h3><a name="CloudI_Filesystem">CloudI Filesystem</a></h3>
A service that caches filesystem data for quick responses.
<p>Copyright © 2011-2014 Michael Truog</p>
<p><b>Version:</b> 1.4.0 Dec 20 2014 17:53:26
------------------------------------------------------------------------</p>
<p><b>Behaviours:</b> <a href="deps/cloudi_core/doc/cloudi_service.html"><tt>cloudi_service</tt></a>.</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog [at] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="CloudI_Filesystem">CloudI Filesystem</a></h3>
A service that caches filesystem data for quick responses.
<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="#cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_handle_request-11">cloudi_service_handle_request/11</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_init-4">cloudi_service_init/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_terminate-3">cloudi_service_terminate/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#notify_all-3">notify_all/3</a></td><td>
<h4><a name="Subscribe_all_service_processes_to_be_notified_of_file_updates.">Subscribe all service processes to be notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</td></tr>
<tr><td valign="top"><a href="#notify_all-4">notify_all/4</a></td><td>
<h4><a name="Subscribe_all_service_processes_to_be_notified_of_file_updates.">Subscribe all service processes to be notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</td></tr>
<tr><td valign="top"><a href="#notify_all-5">notify_all/5</a></td><td>
<h4><a name="Subscribe_all_service_processes_to_be_notified_of_file_updates.">Subscribe all service processes to be notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</td></tr>
<tr><td valign="top"><a href="#notify_clear-2">notify_clear/2</a></td><td>
<h4><a name="Clear_all_notification_subscriptions_for_a_file.">Clear all notification subscriptions for a file.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#notify_one-3">notify_one/3</a></td><td>
<h4><a name="Subscribe_to_have_a_service_process_notified_of_file_updates.">Subscribe to have a service process notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</td></tr>
<tr><td valign="top"><a href="#notify_one-4">notify_one/4</a></td><td>
<h4><a name="Subscribe_to_have_a_service_process_notified_of_file_updates.">Subscribe to have a service process notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</td></tr>
<tr><td valign="top"><a href="#notify_one-5">notify_one/5</a></td><td>
<h4><a name="Subscribe_to_have_a_service_process_notified_of_file_updates.">Subscribe to have a service process notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></h3>
<div class="spec">
<p><tt>cloudi_service_handle_info(Request, State, Dispatcher) -> any()</tt></p>
</div>
<h3 class="function"><a name="cloudi_service_handle_request-11">cloudi_service_handle_request/11</a></h3>
<div class="spec">
<p><tt>cloudi_service_handle_request(Type, Name, Pattern, RequestInfo, File_notify, Timeout, Priority, TransId, Pid, State, Dispatcher) -> any()</tt></p>
</div>
<h3 class="function"><a name="cloudi_service_init-4">cloudi_service_init/4</a></h3>
<div class="spec">
<p><tt>cloudi_service_init(Args, Prefix, Timeout, Dispatcher) -> any()</tt></p>
</div>
<h3 class="function"><a name="cloudi_service_terminate-3">cloudi_service_terminate/3</a></h3>
<div class="spec">
<p><tt>cloudi_service_terminate(Reason, Timeout, State) -> any()</tt></p>
</div>
<h3 class="function"><a name="notify_all-3">notify_all/3</a></h3>
<div class="spec">
<p><tt>notify_all(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a>, Name::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyName::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>) -> {ok, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Subscribe_all_service_processes_to_be_notified_of_file_updates.">Subscribe all service processes to be notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</p>
<h3 class="function"><a name="notify_all-4">notify_all/4</a></h3>
<div class="spec">
<p><tt>notify_all(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a>, Name::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyName::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyTimeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Subscribe_all_service_processes_to_be_notified_of_file_updates.">Subscribe all service processes to be notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</p>
<h3 class="function"><a name="notify_all-5">notify_all/5</a></h3>
<div class="spec">
<p><tt>notify_all(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a>, Name::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyName::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyTimeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>, NotifyPriority::<a href="deps/cloudi_core/doc/cloudi_service.html#type-priority">cloudi_service:priority()</a>) -> {ok, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Subscribe_all_service_processes_to_be_notified_of_file_updates.">Subscribe all service processes to be notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</p>
<h3 class="function"><a name="notify_clear-2">notify_clear/2</a></h3>
<div class="spec">
<p><tt>notify_clear(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a>, Name::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>) -> ok | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Clear_all_notification_subscriptions_for_a_file.">Clear all notification subscriptions for a file.</a></h4>
</p>
<h3 class="function"><a name="notify_one-3">notify_one/3</a></h3>
<div class="spec">
<p><tt>notify_one(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a>, Name::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyName::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>) -> {ok, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Subscribe_to_have_a_service_process_notified_of_file_updates.">Subscribe to have a service process notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</p>
<h3 class="function"><a name="notify_one-4">notify_one/4</a></h3>
<div class="spec">
<p><tt>notify_one(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a>, Name::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyName::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyTimeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Subscribe_to_have_a_service_process_notified_of_file_updates.">Subscribe to have a service process notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</p>
<h3 class="function"><a name="notify_one-5">notify_one/5</a></h3>
<div class="spec">
<p><tt>notify_one(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a>, Name::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyName::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, NotifyTimeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>, NotifyPriority::<a href="deps/cloudi_core/doc/cloudi_service.html#type-priority">cloudi_service:priority()</a>) -> {ok, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Subscribe_to_have_a_service_process_notified_of_file_updates.">Subscribe to have a service process notified of file updates.</a></h4>
The current file contents is returned, if the file is found.</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, Dec 20 2014, 17:53:26.</i></p>
</body>
</html>