summaryrefslogtreecommitdiff
path: root/lib/stdlib/test/shell_docs_SUITE_data/unknown_erlang_alias_1_func.txt
blob: 03aa38c1cd9c3fadd759b82798480ca48652ab0a (plain)
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

  -spec alias(Opts) -> Alias
                 when
                     Alias :: reference(),
                     Opts :: [explicit_unalias | reply].

Since:
  OTP 24.0

  Create an alias which can be used when sending messages to the
  process that created the alias. When the alias has been
  deactivated, messages sent using the alias will be dropped. An
  alias can be deactivated using unalias/1. Currently available
  options for alias/1:

  explicit_unalias:
    The alias can only be deactivated via a call to unalias/1.
    This is also the default behaviour if no options are passed or
    if alias/0 is called.

  reply:
    The alias will be automatically deactivated when a reply
    message sent via the alias is received. The alias can also
    still be deactivated via a call to unalias/1.

  Example:

    server() ->
        receive
            {request, AliasReqId, Request} ->
                Result = perform_request(Request),
                AliasReqId ! {reply, AliasReqId, Result}
        end,
        server().
    
    client(ServerPid, Request) ->
        AliasReqId = alias([reply]),
        ServerPid ! {request, AliasReqId, Request},
        %% Alias will be automatically deactivated if we receive a reply
        %% since we used the 'reply' option...
        receive
            {reply, AliasReqId, Result} -> Result
        after 5000 ->
                unalias(AliasReqId),
                %% Flush message queue in case the reply arrived
                %% just before the alias was deactivated...
                receive {reply, AliasReqId, Result} -> Result
                after 0 -> exit(timeout)
                end
        end.
    	

  Note that both the server and the client in this example must be
  executing on at least OTP 24 systems in order for this to work.

  For more information on process aliases see the Process Aliases
  section of the Erlang Reference Manual.