# Module cloudi_service_filesystem

- Description
- Data Types
- Function Index
- Function Details

### CloudI Filesystem

A service that caches filesystem data for quick responses.

Copyright © 2011-2019 Michael Truog

Version: 1.8.0 Nov 28 2019 14:41:55 ------------------------------------------------------------------------

Behaviours: `cloudi_service`.

Authors: Michael Truog (`mjtruog at protonmail dot com`).

## Description

### CloudI Filesystem

A service that caches filesystem data for quick responses.

## Data Types

### agent()

`agent() = cloudi:agent()`

### priority()

`priority() = cloudi:priority()`

### service_name()

`service_name() = cloudi:service_name()`

### timeout_milliseconds()

`timeout_milliseconds() = cloudi:timeout_milliseconds()`

## Function Index

cloudi_service_handle_info/3 |
cloudi_service_handle_request/11 |
cloudi_service_init/4 |
cloudi_service_terminate/3 |
notify_all/3 | #### Subscribe all service processes to be notified of file updates. The current file contents is returned, if the file is found.
notify_all/4 | #### Subscribe all service processes to be notified of file updates. The current file contents is returned, if the file is found.
notify_all/5 | #### Subscribe all service processes to be notified of file updates. The current file contents is returned, if the file is found.
notify_clear/2 | #### Clear all notification subscriptions for a file. .
notify_one/3 | #### Subscribe to have a service process notified of file updates. The current file contents is returned, if the file is found.
notify_one/4 | #### Subscribe to have a service process notified of file updates. The current file contents is returned, if the file is found.
notify_one/5 | #### Subscribe to have a service process notified of file updates. The current file contents is returned, if the file is found.

## Function Details

### cloudi_service_handle_info/3

`cloudi_service_handle_info(Request, State, Dispatcher) -> any()`

### cloudi_service_handle_request/11

`cloudi_service_handle_request(RequestType, Name, Pattern, RequestInfo, File_notify, Timeout, Priority, TransId, Pid, State, Dispatcher) -> any()`

### cloudi_service_init/4

`cloudi_service_init(Args, Prefix, Timeout, Dispatcher) -> any()`

### cloudi_service_terminate/3

`cloudi_service_terminate(Reason, Timeout, State) -> any()`

### notify_all/3

`notify_all(Agent::agent(), Name::service_name(), NotifyName::service_name()) -> {{ok, binary()} | {error, any()}, NewAgent::agent()}`

#### Subscribe all service processes to be notified of file updates.

The current file contents is returned, if the file is found.

### notify_all/4

`notify_all(Agent::agent(), Name::service_name(), NotifyName::service_name(), NotifyTimeout::timeout_milliseconds()) -> {{ok, binary()} | {error, any()}, NewAgent::agent()}`

#### Subscribe all service processes to be notified of file updates.

The current file contents is returned, if the file is found.

### notify_all/5

`notify_all(Agent::agent(), Name::service_name(), NotifyName::service_name(), NotifyTimeout::timeout_milliseconds(), NotifyPriority::priority()) -> {{ok, binary()} | {error, any()}, NewAgent::agent()}`

#### Subscribe all service processes to be notified of file updates.

The current file contents is returned, if the file is found.

### notify_clear/2

`notify_clear(Agent::agent(), Name::service_name()) -> {ok | {error, any()}, NewAgent::agent()}`

#### Clear all notification subscriptions for a file.

### notify_one/3

`notify_one(Agent::agent(), Name::service_name(), NotifyName::service_name()) -> {{ok, binary()} | {error, any()}, NewAgent::agent()}`

#### Subscribe to have a service process notified of file updates.

The current file contents is returned, if the file is found.

### notify_one/4

`notify_one(Agent::agent(), Name::service_name(), NotifyName::service_name(), NotifyTimeout::timeout_milliseconds()) -> {{ok, binary()} | {error, any()}, NewAgent::agent()}`

#### Subscribe to have a service process notified of file updates.

The current file contents is returned, if the file is found.

### notify_one/5

`notify_one(Agent::agent(), Name::service_name(), NotifyName::service_name(), NotifyTimeout::timeout_milliseconds(), NotifyPriority::priority()) -> {{ok, binary()} | {error, any()}, NewAgent::agent()}`

#### Subscribe to have a service process notified of file updates.

The current file contents is returned, if the file is found.

Generated by EDoc