new Fsw(opts)
an individual Freeswitch server
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Fsw~createOptions | configuration options |
Methods
connect()
connect to the event socket of a freeswitch server, validate the configured sip profile exists, and begin receving heartbeat messages
disconnect()
disconnect from the event socket
Type Definitions
connectCallback(err)
This callback provides the response to a connection attempt to a freeswitch server
Parameters:
| Name | Type | Description |
|---|---|---|
err |
string | error encountered attempting to connect and verify profile, or null if none |
createOptions
Arguments provided when creating an Fsw instance
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
address |
String | hostname or IP address to connect to |
port |
Number | TCP port to connect to |
secret |
String | freeswitch authentication secret |
profile |
String | name of the freeswitch sip profile that will receive the proxied requests |
- Source:
Events
error
Error event triggered when connection to freeswitch media server fails.
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
message |
String | Indicates the reason the connection failed |