exhtml v0.4.0-beta.3 Exhtml.Host

Exhtml.Host represents the content server.

Link to this section Summary

Types

server()

slug()

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

delete_content(server, slug)

Deletes the content from a host

get_content(server, slug)

Gets html content from a host

get_content_since(server, slug, time)

Gets html content from a host with cache time

set_content(server, slug, value)

Sets html content to a host with a slug

set_content_fetcher(server, f)

Sets the content fetcher. A fetcher is used to fetch content from the data source, such as a remote server

start_link(opts \\ [])

Starts a host

update_content(server, slug)

Fetchs and sets the content from the storage to a host’s table

Link to this section Types

server()

server() :: GenServer.server()

slug()

slug() :: Exhtml.slug()

Link to this section Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

delete_content(server, slug)

delete_content(server(), slug()) :: :ok

Deletes the content from a host.

server - the PID or name of the process
slug - the key of the content

get_content(server, slug)

get_content(server(), slug()) :: any()

Gets html content from a host.

server - the PID or name of the process
slug - the key of the content

get_content_since(server, slug, time)

get_content_since(server(), slug(), DateTime.t()) :: any()

Gets html content from a host with cache time.

server - the PID or name of the process
slug - the key of the content
time - the modified time to check.

set_content(server, slug, value)

set_content(server(), slug(), any()) :: :ok

Sets html content to a host with a slug.

server - the PID or name of the process
slug - the key of the content
value - the content to save

Returns :ok.

set_content_fetcher(server, f)

set_content_fetcher(server(), (slug() -> any()) | module()) :: :ok

Sets the content fetcher. A fetcher is used to fetch content from the data source, such as a remote server.

server - the PID or name of the process
f - function or module to fetch content

start_link(opts \\ [])

Starts a host.

opts - options for starting the process
- name - the process name
- content_fetcher - the content fetcher for Exhtml.Storage
- data_dir - the database storage dir for Exhtml.Table
- data_nodes - the database nodes for Exhtml.Table

update_content(server, slug)

update_content(server(), slug()) :: any()

Fetchs and sets the content from the storage to a host’s table.

server - the PID or name of the process
slug - the key of the content

Returns content fetched.