Kamailio module websocket: Difference between revisions

From 탱이의 잡동사니
Jump to navigation Jump to search
(Created page with "== Overview == Kamailio's WebSocket 모듈 내용 정리. The WebSocket module in Kamailio implemented a WebSocket(RFC 6455) server and provides connection establishment(handshaking), management(including connection keep-alive), and framing for the SIP and MSRP WebSocket sub-protocols (RFC 7118 and RFC 7977). == See also == * https://www.kamailio.org/docs/modules/devel/modules/websocket.html category:kamailio")
 
 
Line 3: Line 3:


The WebSocket module in Kamailio implemented a WebSocket(RFC 6455) server and provides connection establishment(handshaking), management(including connection keep-alive), and framing for the SIP and MSRP WebSocket sub-protocols (RFC 7118 and RFC 7977).
The WebSocket module in Kamailio implemented a WebSocket(RFC 6455) server and provides connection establishment(handshaking), management(including connection keep-alive), and framing for the SIP and MSRP WebSocket sub-protocols (RFC 7118 and RFC 7977).
== Parameters ==
=== keepalive_mechanism(integer) ===
The keep-alive mechanism to use for WebSocket connection.
:<b>Note</b>
:If nathelper is only being used for WebSocket connections then nathelper NAT pinging is not required. If nathelper is used for WebSocket connections and TCP/TLS aliasing/NAT-traversal then WebSocket keep-alives are not required.
* 0: no WebSocket keep-alives.
* 1: Ping WebSocket keep-alives.
* 2: Pong WebSocket keep-alives.
Default value is 1.
<pre>
modparam("websocket", "keepalive_mechanism", 0)
</pre>
=== keepalive_timeout(integer) ===
The time(in seconds) after which to send a keep-alive on idle WebSocket connections.
Default value is 180.
<pre>
modparam("websocket", "keepalive_timeout", 50)
</pre>
=== keepalive_processes(integer) ===
The number of processes to start to perform WebSocket connection keep-alives.
Default value is 1.
<pre>
modparam("websocket", "keepalive_processes", 2)
</pre>
=== verbose_list(integer) ===
Allows to enable/disable the printing of debug messages when getting the list of websocket connections. If enabled, it prints debug messages every second for ping operations.
Default value is 0(disabled).
<pre>
modparam("websocket", "verbose_list", 1)
</pre>


== See also ==
== See also ==

Latest revision as of 05:51, 21 September 2023

Overview

Kamailio's WebSocket 모듈 내용 정리.

The WebSocket module in Kamailio implemented a WebSocket(RFC 6455) server and provides connection establishment(handshaking), management(including connection keep-alive), and framing for the SIP and MSRP WebSocket sub-protocols (RFC 7118 and RFC 7977).

Parameters

keepalive_mechanism(integer)

The keep-alive mechanism to use for WebSocket connection.

Note
If nathelper is only being used for WebSocket connections then nathelper NAT pinging is not required. If nathelper is used for WebSocket connections and TCP/TLS aliasing/NAT-traversal then WebSocket keep-alives are not required.
  • 0: no WebSocket keep-alives.
  • 1: Ping WebSocket keep-alives.
  • 2: Pong WebSocket keep-alives.

Default value is 1.

modparam("websocket", "keepalive_mechanism", 0)

keepalive_timeout(integer)

The time(in seconds) after which to send a keep-alive on idle WebSocket connections. Default value is 180.

modparam("websocket", "keepalive_timeout", 50)

keepalive_processes(integer)

The number of processes to start to perform WebSocket connection keep-alives.

Default value is 1.

modparam("websocket", "keepalive_processes", 2)

verbose_list(integer)

Allows to enable/disable the printing of debug messages when getting the list of websocket connections. If enabled, it prints debug messages every second for ping operations.

Default value is 0(disabled).

modparam("websocket", "verbose_list", 1)

See also