API Reference channel_handler v0.5.3

modules

Modules

index

Index

  • join
  • router
    • plug
    • event
    • delegate
    • handle
    • scope
      • plug
      • event
      • delegate
      • handle

docs

Docs

join

join


  • :channel (String.t/0) - The channel path for this handler. By default this has no runtime effect, but can be used by plugs and handlers if necessary.
    The channel value is stored in the socket's :__channel__ assign.

A module implementing an event handler.

A ChannelHandler.Plug, is a function or module that takes the connection socket, the payload and the current handler bindings, and either returns a modified version of each, or directly replies to the client, halting further processing.

For documentation about the router, check ChannelHandler.Dsl.