aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.procs.asciidoc
blob: 0f29533894b981577e890c20466d4bc5152b97b3 (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
= ranch:procs(3)

== Name

ranch:procs - Retrieve pids from a listener

== Description

[source,erlang]
----
procs(Ref  :: ranch:ref(),
      Type :: acceptors | connections)
    -> Pids :: [pid()]
----

Retrieve pids from a listener.

== Arguments

Ref::

The listener name.

Type::

The type of process that will be returned.

== Return value

A list of pids is returned.

== Examples

.Get the pids of the acceptor processes
[source,erlang]
----
Pids = ranch:procs(acceptors).
----

.Get the pids of the connection processes
[source,erlang]
----
Pids = ranch:procs(connections).
----

== See also

link:man:ranch:get_addr(3)[ranch:get_addr(3)],
link:man:ranch:get_port(3)[ranch:get_port(3)],
link:man:ranch:info(3)[ranch:info(3)],
link:man:ranch(3)[ranch(3)]