From a63ee9b363aa7214343966690b50d77f4d3475e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 1 Aug 2018 16:52:33 +0200 Subject: Ranch 1.6.0 --- docs/en/ranch/1.6/manual/ranch_protocol/index.html | 169 +++++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 docs/en/ranch/1.6/manual/ranch_protocol/index.html (limited to 'docs/en/ranch/1.6/manual/ranch_protocol/index.html') diff --git a/docs/en/ranch/1.6/manual/ranch_protocol/index.html b/docs/en/ranch/1.6/manual/ranch_protocol/index.html new file mode 100644 index 00000000..89c1e13c --- /dev/null +++ b/docs/en/ranch/1.6/manual/ranch_protocol/index.html @@ -0,0 +1,169 @@ + + + + + + + + + + Nine Nines: ranch_protocol(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

ranch_protocol(3)

+ +

Name

+

ranch_protocol - Protocol modules

+

Description

+

The module ranch_protocol defines the interface used by Ranch protocols.

+

Callbacks

+

Ranch protocols implement the following interface:

+
+
start_link(Ref       :: ranch:ref(),
+           _,
+           Transport :: module(),
+           ProtoOpts :: any())
+    -> {ok, ConnPid :: pid()}
+     | {ok, SupPid :: pid(), ConnPid :: pid()}
+
+

Start a new connection process.

+

The only purpose of this callback is to start a process that will handle the socket. It must spawn the process, link and then return the new pid. This function will always be called from inside a supervisor.

+

This callback can also return two pids. The first pid is the pid of the process that will be supervised. The second pid is the pid of the process that will receive ownership of the socket. This second process must be a child of the first. This form is only available when connection_type is set to supervisor.

+

If any other value is returned, the supervisor will close the socket and assume no process has been started.

+

Do not perform any operations in this callback, as this would block the supervisor responsible for starting connection processes and degrade performance severely.

+

Changelog

+
  • 1.6: The second argument Socket was deprecated and will be removed in Ranch 2.0. The socket should be obtained by calling ranch:handshake(3). +
    • +
+

See also

+

ranch:handshake(3), ranch(7)

+ + + + + + +
+ +
+ + +

+ Ranch + 1.6 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3