xturn v0.1.0 Xirsys.XTurn.Allocate.Client View Source

Link to this section Summary

Link to this section Functions

Link to this function

add_peer_channel(pid, channel_number, peer_address)

View Source
Link to this function

add_permissions(pid, perms)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

create(id, client_socket, tuple5)

View Source
Link to this function

create(id, client_socket, tuple5, lifetime)

View Source
Link to this function

get_permission_cache(pid)

View Source

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function

open_port_preferred(pid, port)

View Source
Link to this function

open_port_preferred(pid, port, opts)

View Source
Link to this function

open_port_random(pid, opts)

View Source
Link to this function

open_port_range(pid, min, max)

View Source
Link to this function

open_port_range(pid, min, max, opts)

View Source
Link to this function

refresh_channel(pid, id)

View Source
Link to this function

remove_peer_channel(pid, channel_number, peer_address)

View Source
Link to this function

send_channel(pid, channel, data, socket \\ nil, channel_cache \\ nil)

View Source
Link to this function

send_data(msg, cip, cport, socket)

View Source
Link to this function

send_data_channel(channel_number, data, socket, channel_cache)

View Source
Link to this function

send_indication(pid, peer_address, data, socket \\ nil, perms \\ nil)

View Source
Link to this function

set_peer_details(pid, ns, peer_id)

View Source
Link to this function

set_relay_address(pid, relay_address)

View Source
Link to this function

start_link(id, client_socket, tuple5, lifetime)

View Source