chan_websocket: Configuration for chan_websocket¶
This configuration documentation is for functionality provided by chan_websocket.
Overview¶
WebSocket Channel Driver
Configuration File: chan_websocket.conf¶
[global]: Global settings for chan_websocket¶
Since¶
20.18.0, 22.8.0, 23.2.0
Configuration Option Reference¶
| Option Name | Type | Default Value | Regular Expression | Description | Since |
|---|---|---|---|---|---|
| control_message_format | Custom | plain-text | false | Determines the format used for sending and receiving control mesages on the websocket. | 20.18.0, 22.8.0, 23.2.0 |
| write_timeout | Integer | 100 | false | Write timeout (ms). | 20.22.0, 22.12.0, 23.6.0, 24.0.0 |
Configuration Option Descriptions¶
control_message_format¶
Since: 20.18.0, 22.8.0, 23.2.0
-
plain-text- The legacy plain text single-line message format. -
json- The new JSON format.
write_timeout¶
Since: 20.22.0, 22.12.0, 23.6.0, 24.0.0
The maximum number of milliseconds to wait for a write to the WebSocket to succeed. The WebSocket will be closed and the channel hung up when the timeout is reached. For outgoing WebSocket connections, this sets the default timeout which can be overridden in websocket_client.conf.
Note
Success means the write request was accepted by the operating system and does not imply the payload was actually transmitted or received by the server.
Generated Version¶
This documentation was generated from Asterisk branch 23 using version GIT