FreeSWTICH event socket connection.
Constructors
Properties
- eventStream → Stream<Event>
-
Notice that this is a broadcast stream, and multiple listeners will have to obey the rules of these.
read-only - hashCode → int
-
Get a hash code for this object.…
read-only, inherited - log → Logger
-
read-only
- noticeStream → Stream<Packet>
-
read-only
- onDone → Function
-
read / write
- requestStream → Stream<Request>
-
read-only
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.…
inherited
Methods
-
api(
String command, {int timeoutSeconds: 10}) → Future<Response> -
Send an arbitrary API command (blocking mode). Command reference can be found at; https://freeswitch.org/confluence/display/FREESWITCH/mod_commands
-
authenticate(
String password, {int timeoutSeconds: 10}) → Future<Reply> -
Authenticate on the FreeSWITCH server.
-
bgapi(
String command, {String jobUuid: '', int timeoutSeconds: 10}) → Future<Reply> -
Send an arbitrary API command (non-blocking mode). Command reference can be found at; https://freeswitch.org/confluence/display/FREESWITCH/mod_commands
-
connect(
String hostname, int port) → Future<Socket> -
disconnect(
) → Future -
Perform a hard socket disconnect.
-
divert_events(
bool on, {int timeoutSeconds: 10}) → Future<Reply> -
The divert_events switch is available to allow events that an embedded script would expect to get in the inputcallback to be diverted to the event socket.
-
divertEvents(
bool on, {int timeoutSeconds: 10}) → Future<Reply> -
event(
List<String> events, {String format: '', int timeoutSeconds: 10}) → Future<Reply> -
Subscribe the socket to
events
, which will be pumped into the eventStream. -
exit(
{int timeoutSeconds: 10}) → Future<Reply> -
Close the socket connection.
-
filter(
String eventHeader, String valueToFilter, {int timeoutSeconds: 10}) → Future<Reply> -
Specify event types to listen for. Note, this is not a filter out but rather a "filter in," that is, when a filter is applied only the filtered values are received. Multiple filters on a socket connection are allowed.
-
filterDelete(
String eventHeader, String valueToFilter, {int timeoutSeconds: 10}) → Future<Reply> -
Specify the events which you want to revoke the filter. filter delete can be used when some filters are applied wrongly or when there is no use of the filter.…
-
linger(
{int timeoutSeconds: 10}) → Future<Reply> -
Tells FreeSWITCH not to close the socket connect when a channel hangs up. Instead, it keeps the socket connection open until the last event related to the channel has been received by the socket client.
-
logLevel(
int level, {int timeoutSeconds: 10}) → Future<Reply> -
Enable log output. Levels same as the console.conf values
-
myevents(
String uuid, {String format: '', int timeoutSeconds: 10}) → Future<Reply> -
The 'myevents' subscription allows your inbound socket connection to behave like an outbound socket connect. It will "lock on" to the events for a particular uuid and will ignore all other events, closing the socket when the channel goes away or closing the channel when the socket disconnects and all applications have finished executing.
-
nixevent(
String eventTypes, {int timeoutSeconds: 10}) → Future<Reply> -
Suppress the specified type of event. Useful when you want to allow 'event all' followed by 'nixevent <some_event>' to see all but 1 type of event.
-
noEvents(
{int timeoutSeconds: 10}) → Future<Reply> -
Disable all events that were previously enabled with event.
-
nolinger(
{int timeoutSeconds: 10}) → Future<Reply> -
Disable socket lingering. See linger above.
-
nolog(
{int timeoutSeconds: 10}) → Future<Reply> -
Disable log output previously enabled by the log command.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.…
inherited -
sendevent(
String eventName, {int timeoutSeconds: 10}) → Future<Reply> -
Send an event into the event system (multi line input for headers)
-
toString(
) → String -
Returns a string representation of this object.
inherited