From 172800967c2d53251d7cb1015e3c957c5b065bb1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Mon, 5 Dec 2022 17:22:09 +0100
Subject: Document Websocket subprotocol negotiation

---
 src/gun.erl             |  4 +++-
 src/gun_ws_h.erl        |  1 +
 src/gun_ws_protocol.erl | 25 +++++++++++++++++++++++++
 3 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 src/gun_ws_protocol.erl

(limited to 'src')

diff --git a/src/gun.erl b/src/gun.erl
index 880a2ae..b27ea6e 100644
--- a/src/gun.erl
+++ b/src/gun.erl
@@ -267,12 +267,14 @@
 -type ws_opts() :: #{
 	closing_timeout => timeout(),
 	compress => boolean(),
+	default_protocol => module(),
 	flow => pos_integer(),
 	keepalive => timeout(),
 	protocols => [{binary(), module()}],
 	reply_to => pid(),
 	silence_pings => boolean(),
-	tunnel => stream_ref()
+	tunnel => stream_ref(),
+	user_opts => any()
 }.
 -export_type([ws_opts/0]).
 
diff --git a/src/gun_ws_h.erl b/src/gun_ws_h.erl
index 2412122..fca3c9a 100644
--- a/src/gun_ws_h.erl
+++ b/src/gun_ws_h.erl
@@ -13,6 +13,7 @@
 %% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 -module(gun_ws_h).
+-behavior(gun_ws_protocol).
 
 -export([init/4]).
 -export([handle/2]).
diff --git a/src/gun_ws_protocol.erl b/src/gun_ws_protocol.erl
new file mode 100644
index 0000000..7b0cc5c
--- /dev/null
+++ b/src/gun_ws_protocol.erl
@@ -0,0 +1,25 @@
+%% Copyright (c) 2022, Loïc Hoguin <essen@ninenines.eu>
+%%
+%% Permission to use, copy, modify, and/or distribute this software for any
+%% purpose with or without fee is hereby granted, provided that the above
+%% copyright notice and this permission notice appear in all copies.
+%%
+%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+-module(gun_ws_protocol).
+
+-type protocol_state() :: any().
+-export_type([protocol_state/0]).
+
+-callback init(pid(), reference(), cow_http:headers(), gun:ws_opts())
+	-> {ok, protocol_state()}.
+
+-callback handle(cow_ws:frame(), State)
+	-> {ok, non_neg_integer(), State}
+	when State::protocol_state().
-- 
cgit v1.2.3