Websocket configuration (GNU Artanis web-framework Manual)

24.4.1 Websocket configuration ¶

#:websocket `(proto ,protocol_name)

protocol_name can be:

• ’echo for a simple echo test. NOTE: More protocols will be added in the future.

  #:websocket simple_pattern
  

  simple_pattern can be:

  • #t or ’raw will enable a WebSocket on this URL without specifying the protocol. So you will get the raw data from the decoded payload.

    #:websocket `(redirect ,ip/usk)
    

  This is used for redirecting a Websocket stream to another address. ip/usk is an ip or a unix-socket. The string regexp pattern has to match:

  • ^ip://(?:[0-9]{1,3\\.){3}[0-9]{1,3}(:[0-9]{1,5})?$}
  • ^unix://[a-zA-Z-_0-9]+\\.socket$

    #:websocket `(proxy ,protocol)
    

  Setup a proxy with a specific protocol handler. Unlike the regular proxy approach, the proxy in Artanis doesn’t need a listening port. Since it’s always 80/443 or a custom port. The client has to have websocket support. And be able to access the specified URL to establish a websocket connection. The rest is the same as with a regular proxy.