elixir_mod_event

v0.0.10

elixir_mod_event v0.0.10 FSModEvent.Connection

Connection process. A GenServer that you can plug into your own supervisor tree.

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket

Copyright 2015 Marcelo Gornstein marcelog@gmail.com

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Summary

Functions

api(name, command, args \\ "")

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-api

bgapi(name, command, args \\ "")

Executes an API command in background. Returns a Job ID. The calling process will receive a message like {:fs_job_result, job_id, packet} with the result

disable_divert_events(name)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-divert_events

enable_divert_events(name)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-divert_events

event(name, events)

This will always prepend your list with “plain”

exit(name)

https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-exit

filter(name, key, value \\ "")

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-filter

filter_delete(name, key, value \\ "")

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-filterdelete

linger(name)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-linger

log(name, level)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-log

myevents(name, uuid)

This will always prepend your list with “plain”

nixevent(name, events)

Suppress the specified type of event

noevents(name)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-noevents

nolinger(name)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-nolinger

nolog(name)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-nolog

sendevent(name, event, headers \\ [], body \\ "")

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendevent

sendmsg_exec(name, uuid, command, args \\ "", loops \\ 1, body \\ "")

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendmsg

sendmsg_hangup(name, uuid, cause \\ 16)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendmsg

sendmsg_nomedia(name, uuid, info \\ "")

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendmsg

sendmsg_unicast(name, uuid, transport \\ "tcp", flags \\ "native", local_ip \\ "127.0.0.1", local_port \\ 8025, remote_ip \\ "127.0.0.1", remote_port \\ 8026)

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendmsg

start(name, host, port, password)

Starts a connection to FreeSWITCH

start_link(name, host, port, password)

Starts and links a connection to FreeSWITCH

start_listening(name, filter_fun \\ fn _ -> true end)

Registers the caller process as a receiver for all the events for which the filter_fun returns true

stop_listening(name)

Unregisters the caller process as a listener

Functions

api(name, command, args \\ "") 
api(GenServer.server, String.t, String.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-api

For a list of available commands see: https://freeswitch.org/confluence/display/FREESWITCH/mod_commands

bgapi(name, command, args \\ "") 
bgapi(GenServer.server, String.t, String.t) :: String.t

Executes an API command in background. Returns a Job ID. The calling process will receive a message like {:fs_job_result, job_id, packet} with the result.

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-bgapi

disable_divert_events(name) 
disable_divert_events(GenServer.server) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-divert_events

enable_divert_events(name) 
enable_divert_events(GenServer.server) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-divert_events

event(name, events) 
event(GenServer.server, String.t) :: FSModEvent.Packet.t

This will always prepend your list with “plain”.

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-event

exit(name) 
exit(GenServer.server) :: FSModEvent.Packet.t

https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-exit

filter(name, key, value \\ "") 
filter(GenServer.server, String.t, String.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-filter

filter_delete(name, key, value \\ "") 
filter_delete(GenServer.server, String.t, String.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-filterdelete

linger(name) 
linger(GenServer.server) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-linger

log(name, level) 
log(GenServer.server, String.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-log

myevents(name, uuid) 
myevents(GenServer.server, String.t) :: FSModEvent.Packet.t

This will always prepend your list with “plain”.

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-SpecialCase-‘myevents’

nixevent(name, events) 
nixevent(GenServer.server, String.t) :: FSModEvent.Packet.t

Suppress the specified type of event.

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-nixevent

noevents(name) 
noevents(GenServer.server) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-noevents

nolinger(name) 
nolinger(GenServer.server) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-nolinger

nolog(name) 
nolog(GenServer.server) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-nolog

sendevent(name, event, headers \\ [], body \\ "") 
sendevent(GenServer.server, String.t, [{String.t, String.t}], String.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendevent

sendmsg_exec(name, uuid, command, args \\ "", loops \\ 1, body \\ "") 
sendmsg_exec(GenServer.server, String.t, String.t, String.t, Integer.t, String.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendmsg

sendmsg_hangup(name, uuid, cause \\ 16) 
sendmsg_hangup(GenServer.server, String.t, Integer.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendmsg

sendmsg_nomedia(name, uuid, info \\ "") 
sendmsg_nomedia(GenServer.server, String.t, String.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendmsg

sendmsg_unicast(name, uuid, transport \\ "tcp", flags \\ "native", local_ip \\ "127.0.0.1", local_port \\ 8025, remote_ip \\ "127.0.0.1", remote_port \\ 8026) 
sendmsg_unicast(GenServer.server, String.t, String.t, String.t, String.t, Integer.t, String.t, Integer.t) :: FSModEvent.Packet.t

See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-sendmsg

start(name, host, port, password) 
start(atom, String.t, Integer.t, String.t) :: GenServer.on_start

Starts a connection to FreeSWITCH.

start_link(name, host, port, password) 
start_link(atom, String.t, Integer.t, String.t) :: GenServer.on_start

Starts and links a connection to FreeSWITCH.

start_listening(name, filter_fun \\ fn _ -> true end) 
start_listening(GenServer.server, (... -> any)) :: :ok

Registers the caller process as a receiver for all the events for which the filter_fun returns true.

stop_listening(name) 
stop_listening(GenServer.server) :: :ok

Unregisters the caller process as a listener.