Add the 'ranch_protocol' behaviour

1 files changed, 24 insertions, 0 deletions

diff --git a/src/ranch_protocol.erl b/src/ranch_protocol.erl
new file mode 100644
index 0000000..38a56c8
--- /dev/null
+++ b/src/ranch_protocol.erl
@@ -0,0 +1,24 @@
+%% Copyright (c) 2012, Loïc Hoguin <[email protected]>
+%%
+%% 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.
+
+%% @private
+-module(ranch_protocol).
+
+%% Start a new connection process for the given socket.
+-callback start_link(
+		ListenerPid::pid(),
+		Socket::any(),
+		Transport::module(),
+		ProtocolOptions::any())
+	-> {ok, ConnectionPid::pid()}.