aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.handshake_continue.asciidoc
blob: 4fb08bfebfc55ae755718bb2f84404a573a7d786 (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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
= ranch:handshake_continue(3)

== Name

ranch:handshake_continue - Resume the paused transport handshake

== Description

[source,erlang]
----
handshake_continue(Ref)       -> {ok, Socket}
handshake_continue(Ref, Opts) -> {ok, Socket}

Ref    :: ranch:ref()
Opts   :: any()
Socket :: any()
----

Resume the paused transport handshake.

This function must be called by the protocol process in order
to resume a paused handshake.

== Arguments

Ref::

The listener name.

Opts::

Transport handshake options.
+
Allowed options depend on the transport module.

== Return value

An `ok` tuple is returned containing the socket for the connection.

This function will trigger an exception when an error occurs.

== Changelog

* *2.0*: Function introduced.

== Examples

.Continue a paused transport handshake
[source,erlang]
----
start_link(Ref, Transport, Opts) ->
    Pid = proc_lib:spawn_link(?MODULE, init,
        [Ref, Transport, Opts]),
    {ok, Pid}.

init(Ref, Transport, Opts) ->
    {continue, _Info} = ranch:handshake(Ref),
    {ok, Socket} = ranch:handshake_continue(Ref),
    loop(#state{ref=Ref, socket=Socket,
        transport=Transport, opts=Opts}).
----

== See also

link:man:ranch:handshake(3)[ranch:handshake(3)],
link:man:ranch:handshake_cancel(3)[ranch:handshake_cancel(3)],
link:man:ranch(3)[ranch(3)]