phoenix_pubsub_redis v2.1.6 Phoenix.PubSub.Redis View Source
Phoenix PubSub adapter based on Redis.
To use Redis as your PubSub adapter, simply add it to your Endpoint's config:
config :my_app, MyApp.Endpoint,
pubsub: [adapter: Phoenix.PubSub.Redis,
host: "192.168.1.100", node_name: System.get_env("NODE")]
You will also need to add :phoenix_pubsub_redis
to your deps:
defp deps do
[{:phoenix_pubsub_redis, "~> 2.1.0"}]
end
And also add :phoenix_pubsub_redis
to your list of applications:
def application do
[mod: {MyApp, []},
applications: [..., :phoenix, :phoenix_pubsub_redis]]
end
Options
:url
- The url to the redis server ie:redis://username:password@host:port
:name
- The required name to register the PubSub processes, ie:MyApp.PubSub
:node_name
- The required name of the node, defaults to Erlang --sname flag.:host
- The redis-server host IP, defaults"127.0.0.1"
:port
- The redis-server port, defaults6379
:password
- The redis-server password, defaults""
:ssl
- The redis-server ssl option, defaultsfalse
:redis_pool_size
- The size of the redis connection pool. Defaults5
:pool_size
- Both the size of the local pubsub server pool and subscriber shard size. Defaults1
. A single pool is often enough for most use-cases, but for high subscriber counts on a single topic or greater than 1M clients, a pool size equal to the number of schedulers (cores) is a well rounded size.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Link to this section Functions
Link to this function
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
Link to this function