API

WebSocket Transport

This is the default implementation of SIP.Transport for SIP.js. It handles transmission and receipt of SIP requests and responses over a WebSocket connection. This class inherits from SIP.Transport.

For configuration parameters see WebSocket Transport Configuration Parameters.

Dependencies

Instance Variables

logger

Logger - The outlet for log messages.

configuration

Object - The configuration options that have been loaded for the class

ws

WebSocket - The WebSocket used for sending and receiving messages.

server

Object - The wsServer object the transport connects to; comes from the configuration.

connectionTimer

Integer - Global timer ID used to track time taken for connection.

connectionPromise

Promise - The promise from when connect() is called

reconnectionAttempts

Integer - The number of times the Transport has attempted to reconnect in event of error.

reconnectTimer

Integer - Global timer ID used to track time between reconnection attempts.

transportRecoveryAttempts

Integer - The number of times the Transport has attempted to recover

transportRecoveryTimer

Integer - Global timer ID used to track time between recovery attempts.

keepAliveInterval

Integer - Global timer ID used to track time between keepAlive messages

keepAliveDebounceTimeout

Integer - Global timer ID used to debounce keepAlive messages

lastTransportError

Object - When the WebSocket is closed, any error condition gets stored here.

status

Integer - Indicates the connection state of the transport. See constants for list of valid statuses.

Instance Methods

sendMsgPromise()

Internal Contains message sending logic - instantiates a WebSocket and sets up listeners on it

Parameters

msg - String | SIP.OutgoingRequest - A SIP Request to send on the WebSocket

options (optional) - Object with parameters:

Name Mandatory? Type Description
force No Boolean Whether or not to force status assertions and/or transitions

Returns

Promise - resolves with an Object with parameters:

Name Type Value Description
msg String   The message that was just sent
overrideEvent Boolean True Whether or not to emit the default event at resolution time. This implementation emits the event in onOpen().

connectPromise()

Internal Contains connection logic - instantiates a WebSocket and sets up listeners on it

Parameters

options(optional) - Object with parameters:

Name Mandatory? Type Description
force No Boolean Whether or not to force status assertions and/or transitions

Returns

Promise - resolves with an Object with parameters:

Name Type Value Description
overrideEvent Boolean True Whether or not to emit the default event at resolution time. This implementation emits the event in onOpen().

onOpen()

Internal This method is called when the WebSocket is opened. Its primary purpose is to clear the reconnection attempts and propagate a connected event.

Parameters
Name Type Description
resolve Function A promise resolution to call- from connectPromise()

disconnectionPromise()

Internal Contains disconnection logic - closes the WebSocket

Parameters

options(optional) - Object with parameters:

Name Mandatory? Type Description
force No Boolean Whether or not to force status assertions and/or transitions
code No Number A numeric value indicating the status code explaining why the connection has been closed.
reason No String A human-readable string explaining why the connection has been closed.

Returns

Promise - resolves with an Object with parameters:

Name Type Value Description
overrideEvent Boolean True Whether or not to emit the default event at resolution time. This implementation emits the event in onClose().

onClose()

Internal This method is called when the WebSocket is closed. Its primary purpose is to propagate a disconnected event and attempt to reconnect if necessary.

onMessage()

Internal This method is called when a message is received from the WebSocket. It parses the SIP message, runs sanity checks, and passes it to the UA (for requests) or transaction (for responses) for processing.

onError()

Internal Logs an error and emits a transportError event. Errors typically also disconnect the WebSocket, so no extra handling is done here.

reconnect()

Internal Reconnect to the WebSocket server in the event of unexpected disconnection. This will attempt to reconnect up to configuration.maxReconnectionAttempts times, with a gap of configuration.reconnectionTimeout seconds between each request.

getNextWsServer()

Internal Picks the next WebSocket server from configuration.wsServers and returns it. Priority is based on given weight (see configuration.wsServers) and whether the server has been marked as error

Returns

Object a WsServer configuration object (not to be confused with a WebSocket)

noAvailableServers()

Internal Checks all WebSocket servers defined in configuration.wsServers for their error state. Returns true if all servers have property isError set to true.

Returns

Boolean - true if there are no available servers, false otherwise

disposeWs()

Internal Removes all event listeners and then then sets the instance property this.ws to null.

sendKeepAlive()

Internal Sends a double CLRF sequence on the websocket. Is debounced by keepAliveTimeout, which is also set in this function. Configurable by configuration.keepAliveDebounce

Returns

Promise, an invocation of send()

clearKeepAliveTimeout()

Internal Clears the keepAliveTimeout from the global timer provider and sets the instance parameter to null

startSendingKeepAlives()

Internal Sets up an interval to call sendKeepalive() periodically. Configurable by configuration.keepAliveInterval

stopSendingKeepAlives()

Internal Clears the keepAlive interval from the global timer provider and sets the instance parameter to null. Also clears the outstanding keepAliveTimeout

statusAssert()

Internal Checks the current status against the given status for equality, returns true if they are and false if they are not. Can be bypassed by using the force parameter and will always return true, using force will generate warning-level log messages.

Parameters

Name Type Description
status Boolean The status to check
force Boolean Whether or not to bypass the assertion

Returns

Boolean - true if the given status is equal to the current status, false otherwise

statusTransition()

Internal Safely transitions the status by checking with statusAssert(). Can be forced using the force parameter. Only allows certain transitions:

Parameters

Name Type Description
status Boolean The status to transition to
force Boolean Whether or not to bypass the assertion

Allowed Transitions

Start Status   Destination Status
STATUS_CONNECTING => STATUS_OPEN
STATUS_OPEN => STATUS_CLOSING
STATUS_CLOSING => STATUS_CLOSED

Returns

Boolean - true if the transition was successful and false otherwise