exhtml v0.4.0-beta.2 Exhtml.Host
Exhtml.Host represents the content server.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Deletes the content from a host
Gets html content from a host
Gets html content from a host with cache time
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Sets html content to a host with a slug
Sets the content fetcher. A fetcher is used to fetch content from the data source, such as a remote server
Starts a host
Start the repo engine. Before starting a repo, all actions will not be performed and
{:error, :repo_not_started}
will be returned
Fetchs and sets the content from the storage to a host’s table
Link to this section Types
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
Deletes the content from a host.
server
- the PID or name of the processslug
- the key of the content
Gets html content from a host.
server
- the PID or name of the processslug
- the key of the content
get_content_since(server(), slug(), DateTime.t()) :: any()
Gets html content from a host with cache time.
server
- the PID or name of the processslug
- the key of the contenttime
- the modified time to check.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
args
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
Sets html content to a host with a slug.
server
- the PID or name of the processslug
- the key of the contentvalue
- the content to save
Returns :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 processf
- function or module to fetch content
Starts a host.
opts
- options for starting the processname
- the process namecontent_fetcher
- the content fetcher forExhtml.Storage
data_dir
- the database storage dir forExhtml.Table
data_nodes
- the database nodes forExhtml.Table
Start the repo engine. Before starting a repo, all actions will not be performed and
{:error, :repo_not_started}
will be returned.
Fetchs and sets the content from the storage to a host’s table.
server
- the PID or name of the processslug
- the key of the content
Returns content fetched.