aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_sub_protocol.ezdoc
blob: 2ad0cf76c712e474179b82318d63e0ee48fdf735 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
::: cowboy_sub_protocol

The `cowboy_sub_protocol` behaviour defines the interface used
by modules that implement a protocol on top of HTTP.

:: Types

None.

:: Callbacks

: upgrade(Req, Env, Handler, Opts)
	-> {ok, Req, Env}
	| {suspend, Module, Function, Args}
	| {halt, Req}
	| {error, StatusCode, Req}

Types:

* Req = cowboy_req:req()
* Env = env()
* Handler = module()
* Opts = any()
* Module = module()
* Function = atom()
* Args = [any()]
* StatusCode = cowboy:http_status()

Upgrade the protocol.

Please refer to the `cowboy_middleware` manual for a
description of the return values.