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
Specs:
- 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
Specs:
- 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
Specs:
- disable_divert_events(GenServer.server) :: FSModEvent.Packet.t
See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-divert_events
Specs:
- enable_divert_events(GenServer.server) :: FSModEvent.Packet.t
See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-divert_events
Specs:
- 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
Specs:
- exit(GenServer.server) :: FSModEvent.Packet.t
https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-exit
Specs:
- filter(GenServer.server, String.t, String.t) :: FSModEvent.Packet.t
See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-filter
Specs:
- 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
Specs:
- linger(GenServer.server) :: FSModEvent.Packet.t
See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-linger
Specs:
- log(GenServer.server, String.t) :: FSModEvent.Packet.t
See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-log
Specs:
- myevents(GenServer.server, String.t) :: FSModEvent.Packet.t
This will always prepend your list with “plain”.
Specs:
- 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
Specs:
- noevents(GenServer.server) :: FSModEvent.Packet.t
See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-noevents
Specs:
- nolinger(GenServer.server) :: FSModEvent.Packet.t
See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-nolinger
Specs:
- nolog(GenServer.server) :: FSModEvent.Packet.t
See: https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket#mod_event_socket-nolog
Specs:
- 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
Specs:
- 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
Specs:
- 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
Specs:
- 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
Specs:
- 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
Specs:
- start(atom, String.t, Integer.t, String.t) :: GenServer.on_start
Starts a connection to FreeSWITCH.
Specs:
- start_link(atom, String.t, Integer.t, String.t) :: GenServer.on_start
Starts and links a connection to FreeSWITCH.
Specs:
- start_listening(GenServer.server, (... -> any)) :: :ok
Registers the caller process as a receiver for all the events for which the filter_fun returns true.
Specs:
- stop_listening(GenServer.server) :: :ok
Unregisters the caller process as a listener.