cat-bookmarker/deps/phoenix/priv/templates/phx.gen.socket/socket.ex

55 lines
1.7 KiB
Elixir

defmodule <%= module %>Socket do
use Phoenix.Socket
# A Socket handler
#
# It's possible to control the websocket connection and
# assign values that can be accessed by your channel topics.
## Channels<%= if existing_channel do %>
channel "<%= existing_channel[:singular] %>:*", <%= existing_channel[:module] %>Channel
<% else %>
# Uncomment the following line to define a "room:*" topic
# pointing to the `<%= web_module %>.RoomChannel`:
#
# channel "room:*", <%= web_module %>.RoomChannel
#
# To create a channel file, use the mix task:
#
# mix phx.gen.channel Room
#
# See the [`Channels guide`](https://hexdocs.pm/phoenix/channels.html)
# for further details.
<% end %>
# Socket params are passed from the client and can
# be used to verify and authenticate a user. After
# verification, you can put default assigns into
# the socket that will be set for all channels, ie
#
# {:ok, assign(socket, :user_id, verified_user_id)}
#
# To deny connection, return `:error`.
#
# See `Phoenix.Token` documentation for examples in
# performing token verification on connect.
@impl true
def connect(_params, socket, _connect_info) do
{:ok, socket}
end
# Socket id's are topics that allow you to identify all sockets for a given user:
#
# def id(socket), do: "user_socket:#{socket.assigns.user_id}"
#
# Would allow you to broadcast a "disconnect" event and terminate
# all active sockets and channels for a given user:
#
# <%= endpoint_module %>.broadcast("user_socket:#{user.id}", "disconnect", %{})
#
# Returning `nil` makes this socket anonymous.
@impl true
def id(_socket), do: nil
end