WebSockAdapter.Plug (WebSockAdapter v0.7.2)

Copy Markdown View Source

Basic plug to upgrade a connection to WebSock connections without a separate plug.

This simplifies basic usage of WebSockAdapter in combination with plug accepting functions like starting a webserver or hooking into routers, where handler implementation and initial state are static.

For any more advanced cases consider using a custom plug.

Example

opts = [
  impl: HandlerModule,
  state: [initial: :state]
]

Bandit.start_link(port: 4000, plug: {WebSockAdapter.Plug, opts})

Options

  • :impl - Sets the handler implementation module. Required.
  • :state - Sets the handlers initial state. Required.

Any further options will be forwarded to WebSockAdapter.upgrade/4.

Summary

Functions

Callback implementation for Plug.call/2.

Callback implementation for Plug.init/1.

Functions

call(conn, opts)

Callback implementation for Plug.call/2.

init(opts)

Callback implementation for Plug.init/1.