plug_wait1 v0.2.0 Plug.Adapters.Wait1
Adapter interface for the Wait1 websocket subprotocol.
Options
:ip
- the ip to bind the server to. Must be a tuple in the format{x, y, z, w}
.:port
- the port to run the server. Defaults to 4000 (http) and 4040 (https).:acceptors
- the number of acceptors for the listener. Defaults to 100.:max_connections
- max number of connections supported. Defaults to:infinity
.:dispatch
- manually configure Cowboy’s dispatch. If this option is used, the given plug won’t be initialized nor dispatched to (and doing so becomes the user responsibility).:ref
- the reference name to be used. Defaults toplug.HTTP
(http) andplug.HTTPS
(https). This is the value that needs to be given on shutdown.:compress
- Cowboy will attempt to compress the response body.
Summary
Functions
Returns a child spec to be supervised by your application
Run Wait1 under http
Run Wait1 under https
Shutdowns the given reference
Functions
Returns a child spec to be supervised by your application.
Run Wait1 under http.
Example
# Starts a new interface
Plug.Adapters.Wait1.http MyPlug, [], port: 80
# The interface above can be shutdown with
Plug.Adapters.Wait1.shutdown MyPlug.HTTP
Run Wait1 under https.
see Plug.Adapters.Cowboy for more information
Example
# Starts a new interface
Plug.Adapters.Wait1.https MyPlug, [],
port: 443,
password: "SECRET",
otp_app: :my_app,
keyfile: "ssl/key.pem",
certfile: "ssl/cert.pem"
# The interface above can be shutdown with
Plug.Adapters.Wait1.shutdown MyPlug.HTTPS