Module: kamailio
Branch: master
Commit: d33ee59bc807acf95b07838d24b888b14a286ddd
URL: https://github.com/kamailio/kamailio/commit/d33ee59bc807acf95b07838d24b888b…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2018-11-16T10:37:19+01:00
websocket: aligned example statements
- few more details about return code of handshake process
---
Modified: src/modules/websocket/doc/websocket_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/d33ee59bc807acf95b07838d24b888b…
Patch: https://github.com/kamailio/kamailio/commit/d33ee59bc807acf95b07838d24b888b…
---
diff --git a/src/modules/websocket/doc/websocket_admin.xml b/src/modules/websocket/doc/websocket_admin.xml
index 055498862e..338d37ef22 100644
--- a/src/modules/websocket/doc/websocket_admin.xml
+++ b/src/modules/websocket/doc/websocket_admin.xml
@@ -90,13 +90,13 @@ event_route[xhttp:request] {
# Optional... perform HTTP authentication
# ws_handle_handshake() exits (no further configuration file
- # processing of the request) when complete.
+ # processing of the request) when complete in case of failure.
if (ws_handle_handshake())
- {
- # Optional... cache some information about the
- # successful connection
- exit;
- }
+ {
+ # Optional... cache some information about the
+ # successful connection
+ exit;
+ }
}
xhttp_reply("404", "Not found", "", "");
@@ -181,9 +181,9 @@ route[WITHINDLG] {
onreply_route[WS_REPLY] {
if (nat_uac_test(64)) {
# Do NAT traversal stuff for replies to a WebSocket connection
- # - even if it is not behind a NAT!
+ # - even if it is not behind a NAT!
# This won't be needed in the future if Kamailio and the
- # WebSocket client support Outbound and Path.
+ # WebSocket client support Outbound and Path.
add_contact_alias();
}
}
@@ -491,7 +491,8 @@ end
<para>This function can be used from ANY_ROUTE (but will only
work in <emphasis>event_route[xhttp:request]</emphasis>).</para>
<note><para>This function returns 0, stopping all further
- processing of the request, when there is a problem.</para></note>
+ processing of the request, when there is a problem. Otherwise, it
+ returns 1 (or positive number) in case of success.</para></note>
<example>
<title><function>ws_handle_handshake</function> usage</title>
<programlisting format="linespecific">
### Description
It was reported that using the RPM for v5.0.7 from opensuse build service is getting an error on dependency for internal lib ims.
Getting the rpm from:
* http://download.opensuse.org/repositories/home:/kamailio:/v5.0.x-rpms/RHEL_…
Then:
```
rpm -ivh kamailio-5.0.7-8.el7.x86_64.rpm
warning: kamailio-5.0.7-8.el7.x86_64.rpm: Header V3 DSA/SHA1 Signature, key ID 941fdbdd: NOKEY
error: Failed dependencies:
libkamailio_ims.so.0()(64bit) is needed by kamailio-5.0.7-8.el7.x86_64
```
### Troubleshooting
#### Reproduction
See above.
### Additional Information
* **Kamailio Version** - output of `kamailio -v`
```
5.0.7, but can be the same for 5.1 or newer.
```
* **Operating System**:
```
RHEL 7, but can be the same for other OSes
```
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/issues/1721