aboutsummaryrefslogblamecommitdiffstats
path: root/doc/src/manual/cowboy_handler.terminate.asciidoc
blob: c995ba367f34103f0700581c6e8925b755efd8ca (plain) (tree)
1
2
3
4
5
6
7
8
9
10








                                                
                                                   
 


                      











                                                          
            

               

                                                                  


























                                                           
= cowboy_handler:terminate(3)

== Name

cowboy_handler:terminate - Terminate the handler

== Description

[source,erlang]
----
terminate(Reason, PartialReq, State, Handler) -> ok

Reason     :: any()
PartialReq :: map()
State      :: any()
Handler    :: module()
----

Call the optional terminate callback if it is defined.

Make sure to use this function at the end of the execution
of modules that implement custom handler behaviors.

== Arguments

Reason::

Reason for termination.

PartialReq::

The Req object.
+
It is possible to remove fields from the Req object to save memory
when the handler has no concept of requests/responses. The only
requirement is that a map is provided.

State::

Handler state.

Handler::

Handler module.

== Return value

The atom `ok` is always returned. It can be safely ignored.

== Changelog

* *2.0*: Function introduced.

== Examples

.Terminate a handler normally
[source,erlang]
----
cowboy_handler:terminate(normal, Req, State, Handler).
----

== See also

link:man:cowboy_handler(3)[cowboy_handler(3)]