chugunov / socketio_emitter

socketio_emitter allows you to communicate with socket.io servers easily from Elixir processes.

socketio_emitter

socketio_emitter allows you to communicate with socket.io servers easily from Elixir processes. Inspired by socket.io-emitter

Installation

The package can be installed by adding socketio_emitter to your list of dependencies in mix.exs:

def deps do
  [{:socketio_emitter, "~> 0.1.2"}]
end

How to use

Register socketio_emitter supervisor at your supervisor tree:

defmodule ExampleApp do
  use Application

  def start(_type, _args) do
    import Supervisor.Spec

    children = [
      # Add this line to your supervisor tree
      supervisor(SocketIOEmitter, []),
    ]

    opts = [strategy: :one_for_one, name: ExampleApp.Supervisor]
    Supervisor.start_link(children, opts)
  end
end

Then call SocketIOEmitter.emit/2:

msg = %{:text => "hello"}

# sending to all clients
{:ok, _consumers_count} =  SocketIOEmitter.emit ["broadcast", msg]

# sending to all clients in 'game' room
{:ok, _consumers_count} =  SocketIOEmitter.emit ["new-game", msg],
  rooms: ["game"]
  
# sending to individual socketid (private message)
{:ok, _consumers_count} =  SocketIOEmitter.emit ["private", msg],
  rooms: [socket_id]
  
# sending to all clients in 'admin' namespace
{:ok, _consumers_count} =  SocketIOEmitter.emit ["namespace", msg],
  nsp: "/admin"
  
# sending to all clients in 'admin' namespace and in 'notifications' room
{:ok, _consumers_count} =  SocketIOEmitter.emit ["namespace", msg],
  nsp: "/admin",
  rooms: ["notifications"]

Configuration

You can configure socketio_emitter from your config.exs. See the redix documentation for the possible values of redix_config.

use Mix.Config

config :socketio_emitter, :redix_pool,
  redix_config: [
    # default value: localhost
    host: "example.com",
    # default value: 6379
    port: 5000,
  ],
  # 5 Redix processes will be available (default value: 1)
  pool_size: 5

Or passing by parameters directly to supervisor, in this way values from config will be overridden:

redix_pool = [redix_config: [
    host: "localhost",
    port: 6379
  ], pool_size: 3]

children = [
  # Add this line to your supervisor tree
  supervisor(SocketIOEmitter, [redix_pool], [name: :socket_emitter])
]

TODO

• tests
• documentation

License

MIT

socketio_emitter's Issues

why does it depend on redix?

I don't understand why this package relies on redix to emit messages.
I'm trying to connect to a third party socket.io server and they don't have any information on redis support.

Can I still use this to connect with their socket.io server?
The socket.io server url I'm trying to connect is https://ws-api.iextrading.com/1.0/tops (here's a example),
if this package can do it, how should I configure?

Thanks