event_socket_outbound

v0.4.0

event_socket_outbound v0.4.0 EventSocketOutbound.Protocol View Source

Protocol handler starts a connection process and defines logic for FreeSWITCH events and protocol.

Link to this section Summary

Functions

answer(pid)

Answers the call. For further details, refer to FreeSWITCH docs

api(pid, command, args)

Send an api command. For further details, refer to FreeSWITCH docs

child_spec(arg)

Returns a specification to start this module under a supervisor

conference(pid, args)

Send a conference command. For further details, refer to FreeSWITCH docs

connect(pid)

Once the connection is accepted, run this command in order to get all information about the call. For further details, refer to FreeSWITCH docs

eventplain(pid, args)

Enable or disable events by class or all. For further details, refer to FreeSWITCH docs

execute(pid, command, args)

Execute a dialplan application, and wait for a response from the server. For further details, refer to FreeSWITCH docs

filter(pid, args)

Filtered events will come to the app. For further details, refer to FreeSWITCH docs

hangup(pid, reason \\ "")

Hangs the call. For further details, refer to FreeSWITCH docs

linger(pid, args \\ "")

Not to close the socket connect when a channel hangs up. For further details, refer to FreeSWITCH docs

myevents(pid)

It will "lock on" to the events for a particular uuid and will ignore all other events. For further details, refer to FreeSWITCH docs

start_link(ref, socket, transport, module_protocol)

Callback implementation for c::ranch_protocol.start_link/4

Link to this section Functions

Link to this function

answer(pid) View Source 
answer(pid()) :: term()

Answers the call. For further details, refer to FreeSWITCH docs.

Link to this function

api(pid, command, args) View Source 
api(pid(), String.t(), String.t()) :: term()

Send an api command. For further details, refer to FreeSWITCH docs.

Link to this function

child_spec(arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

conference(pid, args) View Source 
conference(pid(), String.t()) :: term()

Send a conference command. For further details, refer to FreeSWITCH docs.

Link to this function

connect(pid) View Source 
connect(pid()) :: term()

Once the connection is accepted, run this command in order to get all information about the call. For further details, refer to FreeSWITCH docs.

Link to this function

eventplain(pid, args) View Source 
eventplain(pid(), String.t()) :: term()

Enable or disable events by class or all. For further details, refer to FreeSWITCH docs.

Link to this function

execute(pid, command, args) View Source 
execute(pid(), String.t(), String.t()) :: term()

Execute a dialplan application, and wait for a response from the server. For further details, refer to FreeSWITCH docs.

Link to this function

filter(pid, args) View Source 
filter(pid(), String.t()) :: term()

Filtered events will come to the app. For further details, refer to FreeSWITCH docs.

Link to this function

hangup(pid, reason \\ "") View Source 
hangup(pid(), String.t()) :: term()

Hangs the call. For further details, refer to FreeSWITCH docs.

Link to this function

linger(pid, args \\ "") View Source 
linger(pid(), String.t()) :: term()

Not to close the socket connect when a channel hangs up. For further details, refer to FreeSWITCH docs.

Link to this function

myevents(pid) View Source 
myevents(pid()) :: term()

It will "lock on" to the events for a particular uuid and will ignore all other events. For further details, refer to FreeSWITCH docs.

Link to this function

start_link(ref, socket, transport, module_protocol) View Source 
start_link(reference(), any(), module(), any()) :: {:ok, pid()}

Callback implementation for c::ranch_protocol.start_link/4.