Packages

push_ex

1.0.1-rc3
2.2.0 2.1.0 2.0.0 1.2.0 1.1.0 1.0.2 1.0.1-rc3 1.0.1-rc2 1.0.1-rc1 1.0.0-rc9 1.0.0-rc8 1.0.0-rc7 1.0.0-rc6 1.0.0-rc5 1.0.0-rc4 1.0.0-rc3 1.0.0-rc2 1.0.0-rc15 1.0.0-rc14 1.0.0-rc13 1.0.0-rc12 1.0.0-rc11 1.0.0-rc10 1.0.0-rc1 0.2.0-rc2 0.2.0-rc1 0.1.0-rc1 0.0.1-rc4 0.0.1-rc3 0.0.1-rc2 0.0.1-rc

PushEx is an implementation of Phoenix websockets/channels which handles best practices of running websockets for you, but allows your business logic to be specified through simple behaviour modules.

HexDocs

Current section

Files

Jump to
Readme
31 Versions
8 Dependencies
Dependants
Files
Activity
push_ex lib push_ex behaviour controller.ex
Raw

lib/push_ex/behaviour/controller.ex 

defmodule PushEx.Behaviour.Controller do

  @moduledoc """

  Implementable functions that are used by the API controller. It is crucial to ensure that all API calls are secured behind proper auth.

  """



  @doc """

  Accepts a Plug.Conn and params map to determine if the API is allowed to be accessed. It is possible to modify

  the response Plug.Conn completely, or return simple `:ok | :error` atoms.

  """

  @callback auth(Plug.Conn.t(), map()) :: :ok | {:ok, Plug.Conn.t(), map()} | :error | {:error, Plug.Conn.t()}

end