https://github.com/nicholasjhenry/polished-wave

Simple introduction to Phoenix Web Sockets
https://github.com/nicholasjhenry/polished-wave

demo phoenix-framework professional-development

Last synced: 11 months ago
JSON representation

Simple introduction to Phoenix Web Sockets

• Host: GitHub
• URL: https://github.com/nicholasjhenry/polished-wave
• Owner: nicholasjhenry
• Created: 2021-02-05T17:14:12.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-02-05T17:14:23.000Z (over 5 years ago)
• Last Synced: 2025-06-01T09:25:12.833Z (about 1 year ago)
• Topics: demo, phoenix-framework, professional-development
• Language: Elixir
• Homepage:
• Size: 206 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Polished Wave

A simple example of Phoenix running web sockets.

Examples based on [Real-Time Phoenix - Build Highly Scalable Systems with Channels](https://pragprog.com/titles/sbsockets/real-time-phoenix/).

## Setup

    make phx.setup

    make wscat.install

## Start server

    iex -S mix phx.server

## Guide

NOTE: Exclude all comments, including trailing comments.

The `Phoenix.Message` is structured:

    [join ref, message ref, topic, event, payload]

    ["1","1","ping","phx_join",{}]

    # try pinging

     $ wscat -c 'ws://localhost:4000/socket/websocket?vsn=2.0.0'

     > ["1","1","ping","phx_join",{}]

     > ["1","2","ping","ping",{}]

    # try wildcard

    $ wscat -c 'ws://localhost:4000/socket/websocket?vsn=2.0.0'

    > ["1","1","wild:1:2","phx_join",{}] # ok

    > ["1","2","wild:1:3","phx_join",{}] # error

    # try broadcast

    $ wscat -c 'ws://localhost:4000/socket/websocket?vsn=2.0.0'

    > ["1","1","ping","phx_join",{}]

    # must be the same instance phx server instance

    PolishedWaveWeb.Endpoint.broadcast("ping", "test", %{data: "test"})

    # open the browser and view the console

    open http://localhost:4000