sidewalk v0.3.1 Sidewalk
Sidewalk is an Elixir client which is compatible with Sidekiq, the »efficient background processing library for Ruby«. It can be used to enqueue jobs for later processing alongside e.g. with an already existing Ruby application. For more information about Sidekiq please refer to http://sidekiq.org.
Supported features
- Redis namespaces as already known with Sidekiq
- Ability to configure the Redis server connection details
- Ability to configuration a Redis pool size
- Enqueuing jobs to be executed immediately
- Enqueuing jobs to be executed in X seconds
- Enqueuing jobs to be executed at a specific time
Configuration example
config :sidewalk,
host: "localhost",
port: 6379,
password: "you password",
namespace: "your_namespace",
database: 0,
pool_size: 10
Adding sidewalk to your applications
def application do
[applications: [:sidewalk],
mod: {YourApplication, []}]
end
To use Sidewalk you need to create a %Sidewalk.Job{}
and enqueue it with one of the enqueue functions.
Link to this section Summary
Functions
Called when an application is started
Link to this section Functions
Called when an application is started.
This function is called when an the application is started using
Application.start/2
(and functions on top of that, such as
Application.ensure_started/2
). This function should start the top-level
process of the application (which should be the top supervisor of the
application’s supervision tree if the application follows the OTP design
principles around supervision).
start_type
defines how the application is started:
:normal
- used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another mode and the application specification key:start_phases
is:undefined
.{:takeover, node}
- used if the application is distributed and is started on the current node because of a failover on the nodenode
.{:failover, node}
- used if the application is distributed and is started on the current node because of a failover on nodenode
, and the application specification key:start_phases
is not:undefined
.
start_args
are the arguments passed to the application in the :mod
specification key (e.g., mod: {MyApp, [:my_args]}
).
This function should either return {:ok, pid}
or {:ok, pid, state}
if
startup is successful. pid
should be the PID of the top supervisor. state
can be an arbitrary term, and if omitted will default to []
; if the
application is later stopped, state
is passed to the stop/1
callback (see
the documentation for the c:stop/1
callback for more information).
use Application
provides no default implementation for the start/2
callback.
Callback implementation for Application.start/2
.