cowboy_spdy.asciidoc 906 B

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. = cowboy_spdy(3)
  2. == Name
  3. cowboy_spdy - SPDY protocol
  4. == Description
  5. The `cowboy_spdy` module implements SPDY/3 as a Ranch protocol.
  6. == Types
  7. === opts() = [Option]
  8. [source,erlang]
  9. ----
  10. Option = {env, cowboy_middleware:env()}
  11. | {middlewares, [module()]}
  12. | {onresponse, cowboy:onresponse_fun()}
  13. ----
  14. Configuration for the SPDY protocol handler.
  15. This configuration is passed to Cowboy when starting listeners
  16. using the `cowboy:start_spdy/4` function.
  17. It can be updated without restarting listeners using the
  18. Ranch functions `ranch:get_protocol_options/1` and
  19. `ranch:set_protocol_options/2`.
  20. == Option descriptions
  21. The default value is given next to the option name.
  22. env ([{listener, Ref}])::
  23. Initial middleware environment.
  24. middlewares ([cowboy_router, cowboy_handler])::
  25. List of middlewares to execute for every requests.
  26. onresponse (undefined)::
  27. Fun called every time a response is sent.