Browse Source

Document stopping the listener in App:stop/1

Loïc Hoguin 5 years ago
parent
commit
99df823cc3

+ 14 - 1
doc/src/guide/listeners.asciidoc

@@ -75,7 +75,7 @@ start(_Type, _Args) ->
     Dispatch = cowboy_router:compile([
     Dispatch = cowboy_router:compile([
         {'_', [{"/", hello_handler, []}]}
         {'_', [{"/", hello_handler, []}]}
     ]),
     ]),
-    {ok, _} = cowboy:start_tls(my_http_listener,
+    {ok, _} = cowboy:start_tls(my_https_listener,
         [
         [
             {port, 8443},
             {port, 8443},
             {certfile, "/path/to/certfile"},
             {certfile, "/path/to/certfile"},
@@ -101,6 +101,19 @@ Cowboy 2.0 gets released.
 Compatibility with HTTP/1.0 is provided by Cowboy's HTTP/1.1
 Compatibility with HTTP/1.0 is provided by Cowboy's HTTP/1.1
 implementation.
 implementation.
 
 
+=== Stopping the listener
+
+When starting listeners along with the application it is
+a good idea to also stop the listener when the application
+stops. This can be done by calling `cowboy:stop_listener/1`
+in the application's stop function:
+
+[source,erlang]
+----
+stop(_State) ->
+    ok = cowboy:stop_listener(my_http_listener).
+----
+
 === Protocol configuration
 === Protocol configuration
 
 
 The HTTP/1.1 and HTTP/2 protocols share the same semantics;
 The HTTP/1.1 and HTTP/2 protocols share the same semantics;

+ 1 - 1
examples/chunked_hello_world/src/chunked_hello_world_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	chunked_hello_world_sup:start_link().
 	chunked_hello_world_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/compress_response/src/compress_response_app.erl

@@ -23,4 +23,4 @@ start(_Type, _Args) ->
 	compress_response_sup:start_link().
 	compress_response_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/cookie/src/cookie_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	cookie_sup:start_link().
 	cookie_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/echo_get/src/echo_get_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	echo_get_sup:start_link().
 	echo_get_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/echo_post/src/echo_post_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	echo_post_sup:start_link().
 	echo_post_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/eventsource/src/eventsource_app.erl

@@ -23,4 +23,4 @@ start(_Type, _Args) ->
 	eventsource_sup:start_link().
 	eventsource_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/file_server/src/file_server_app.erl

@@ -26,4 +26,4 @@ start(_Type, _Args) ->
 	file_server_sup:start_link().
 	file_server_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/hello_world/src/hello_world_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	hello_world_sup:start_link().
 	hello_world_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/markdown_middleware/src/markdown_middleware_app.erl

@@ -23,4 +23,4 @@ start(_Type, _Args) ->
 	markdown_middleware_sup:start_link().
 	markdown_middleware_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/rest_basic_auth/src/rest_basic_auth_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	rest_basic_auth_sup:start_link().
 	rest_basic_auth_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/rest_hello_world/src/rest_hello_world_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	rest_hello_world_sup:start_link().
 	rest_hello_world_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/rest_pastebin/src/rest_pastebin_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	rest_pastebin_sup:start_link().
 	rest_pastebin_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/ssl_hello_world/src/ssl_hello_world_app.erl

@@ -26,4 +26,4 @@ start(_Type, _Args) ->
 	ssl_hello_world_sup:start_link().
 	ssl_hello_world_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(https).

+ 1 - 1
examples/upload/src/upload_app.erl

@@ -22,4 +22,4 @@ start(_Type, _Args) ->
 	upload_sup:start_link().
 	upload_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).

+ 1 - 1
examples/websocket/src/websocket_app.erl

@@ -23,4 +23,4 @@ start(_Type, _Args) ->
 	websocket_sup:start_link().
 	websocket_sup:start_link().
 
 
 stop(_State) ->
 stop(_State) ->
-	ok.
+	ok = cowboy:stop_listener(http).