From fe3492a98de29942477b061cd02c92246f4bf85a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 28 Mar 2016 15:36:42 +0200 Subject: Initial commit, new website system --- docs/en/ranch/1.2/manual/ranch_protocol/index.html | 217 +++++++++++++++++++++ 1 file changed, 217 insertions(+) create mode 100644 docs/en/ranch/1.2/manual/ranch_protocol/index.html (limited to 'docs/en/ranch/1.2/manual/ranch_protocol/index.html') diff --git a/docs/en/ranch/1.2/manual/ranch_protocol/index.html b/docs/en/ranch/1.2/manual/ranch_protocol/index.html new file mode 100644 index 00000000..aa0001c6 --- /dev/null +++ b/docs/en/ranch/1.2/manual/ranch_protocol/index.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + Nine Nines: ranch_protocol(3) + + + + + + + + + + + + + + + + +
+
+
+
+

99s

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

ranch_protocol(3)

+ +
+

Name

+
+

ranch_protocol - behaviour for protocol modules

+
+
+
+

Description

+
+

The ranch_protocol behaviour defines the interface used +by Ranch protocols.

+
+
+
+

Types

+
+

None.

+
+
+
+

Callbacks

+
+
+

start_link(Ref, Socket, Transport, ProtoOpts) → {ok, pid()} | {ok, pid(), pid()}

+
+
+Ref = ranch:ref() +
+
+

+Listener name. +

+
+
+Socket = any() +
+
+

+Socket for this connection. +

+
+
+Transport = module() +
+
+

+Transport module for this socket. +

+
+
+ProtoOpts = any() +
+
+

+Protocol options. +

+
+
+

Start a new connection process for the given socket.

+

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.

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

+ Ranch + 1.2 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 1.2
    • + +
+ +
+
+
+
+ + + + + + + + + + + + -- cgit v1.2.3