<!-- Kamailio Pull Request Template -->
<!--
IMPORTANT:
- for detailed contributing guidelines, read:
https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md
- pull requests must be done to master branch, unless they are backports
of fixes from master branch to a stable branch
- backports to stable branches must be done with 'git cherry-pick -x ...'
- code is contributed under BSD for core and main components (tm, sl, auth, tls)
- code is contributed GPLv2 or a compatible license for the other components
- GPL code is contributed with OpenSSL licensing exception
-->
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list -->
- [x] Commit message has the format required by CONTRIBUTING guide
- [x] Commits are split per component (core, individual modules, libs, utils, ...)
- [x] Each component has a single commit (if not, squash them into one commit)
- [x] No commits to README files for modules (changes must be done to docbook files
in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change
- [ ] Small bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply -->
- [x] PR should be backported to stable branches
- [x] Tested changes locally
- [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description
<!-- Describe your changes in detail -->
The timeout_socket feature has been added in 2010, but from the look of it it has been designed for the "ngcp-mediaproxy-ng" and never worked with the real RTPProxy. As such both the documentation and the code needs to be adjusted to make it actually useful with the RTPProxy.
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/3598
-- Commit Summary --
* Make timeout notification useable by allowing a notify tag to
* Update rtpproxy module documentation:
-- File Changes --
M src/modules/rtpproxy/doc/rtpproxy.xml (2)
M src/modules/rtpproxy/doc/rtpproxy_admin.xml (38)
M src/modules/rtpproxy/rtpproxy.c (53)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/3598.patchhttps://github.com/kamailio/kamailio/pull/3598.diff
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/3598
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/pull/3598(a)github.com>
Module: kamailio
Branch: master
Commit: 190ef9a54df33b4d053a4225e9d6257e0a045008
URL: https://github.com/kamailio/kamailio/commit/190ef9a54df33b4d053a4225e9d6257…
Author: Maksym Sobolyev <sobomax(a)sippysoft.com>
Committer: Victor Seva <linuxmaniac(a)torreviejawireless.org>
Date: 2023-10-20T09:57:47+02:00
rtpproxy: Update rtpproxy module documentation.
o Correct description of the timeout_socket;
o Document timeout_tag_pv;
o Update (c);
o Remove reference to the ngcp-mediaproxy-ng which does not exist
anymore.
---
Modified: src/modules/rtpproxy/doc/rtpproxy.xml
Modified: src/modules/rtpproxy/doc/rtpproxy_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/190ef9a54df33b4d053a4225e9d6257…
Patch: https://github.com/kamailio/kamailio/commit/190ef9a54df33b4d053a4225e9d6257…
---
diff --git a/src/modules/rtpproxy/doc/rtpproxy.xml b/src/modules/rtpproxy/doc/rtpproxy.xml
index 94886eaf404..ee1fdad9fc8 100644
--- a/src/modules/rtpproxy/doc/rtpproxy.xml
+++ b/src/modules/rtpproxy/doc/rtpproxy.xml
@@ -67,7 +67,7 @@
</editor>
</authorgroup>
<copyright>
- <year>2003-2008</year>
+ <year>2003-2023</year>
<holder>Sippy Software, Inc.</holder>
</copyright>
<copyright>
diff --git a/src/modules/rtpproxy/doc/rtpproxy_admin.xml b/src/modules/rtpproxy/doc/rtpproxy_admin.xml
index 79a85edad70..b04baa5e3dc 100644
--- a/src/modules/rtpproxy/doc/rtpproxy_admin.xml
+++ b/src/modules/rtpproxy/doc/rtpproxy_admin.xml
@@ -18,11 +18,7 @@
<title>Overview</title>
<para>
This is a module that enables media streams to be proxied
- via an rtpproxy. Rtpproxies know to work with this module
- are Sippy RTPproxy <ulink url="http://www.rtpproxy.org"></ulink>
- and ngcp-rtpproxy-ng
- <ulink url="http://deb.sipwise.com/spce/2.6/pool/main/n/ngcp-mediaproxy-ng"></ulink>.
- Some features of the rtpproxy module apply only to one of the two rtpproxies.
+ via the Sippy RTPproxy <ulink url="http://www.rtpproxy.org"></ulink>.
</para>
</section>
@@ -235,7 +231,37 @@ modparam("rtpproxy", "nortpproxy_str", "a=sdpmangled:yes\r\n")
<title>Set <varname>timeout_socket</varname> parameter</title>
<programlisting format="linespecific">
...
-modparam("rtpproxy", "timeout_socket", "xmlrpc:http://127.0.0.1:8000/RPC2")
+modparam("rtpproxy", "timeout_socket", "tcp:127.0.0.1:8000")
+...
+</programlisting>
+ </example>
+ </section>
+ <section id="rtpproxy.p.timeout_tag_pv">
+ <title><varname>timeout_tag_pv</varname> (string)</title>
+ <para>
+ The parameter devines the AVP of the string to be provided to the
+ RTP-Proxy.
+ </para>
+ <para>
+ The content of the AVP must be a valid URL-encoded string with
+ no spaces.
+ It will be decoded and send by the RTP proxy to the timeout socket if the
+ media timeout has happened.
+ </para>
+ <para>
+ This parameter is required in order for the timeout notification
+ mechanism to work properly.
+ </para>
+ <para>
+ <emphasis>
+ Default value is <quote></quote> (nothing).
+ </emphasis>
+ </para>
+ <example>
+ <title>Set <varname>timeout_tag_pv</varname> parameter</title>
+ <programlisting format="linespecific">
+...
+modparam("rtpproxy", "timeout_tag_pv", "$avp(rtpp_ntag)")
...
</programlisting>
</example>
Hello,
I would like to set a timeout in milliseconds when using Kamailio module http_client.
From what I read, the module is accepting a parameter "connection_timeout":
https://www.kamailio.org/docs/modules/devel/modules/http_client.html#http_c…
This is used to set curl option "CURLOPT_TIMEOUT".
I would like to set instead curl option "CURLOPT_TIMEOUT_MS".
I think changing the parameter "connection_timeout" from seconds to milliseconds is not a good idea, since it would break existing configurations.
What about adding a new parameter "connection_timeout_ms" to the module ?
Curl documentation says that: "If both CURLOPT_TIMEOUT and CURLOPT_TIMEOUT_MS are set, the value set last is used."
The CURLOPT_TIMEOUT_MS should only be set if the parameter is non-zero, so that the current behaviour is kept if the new parameter is not configured.
What do you think ?
Regards,
Nicolas.
This message contains information that may be privileged or confidential and is the property of the Capgemini Group. It is intended only for the person to whom it is addressed. If you are not the intended recipient, you are not authorized to read, print, retain, copy, disseminate, distribute, or use this message or any part thereof. If you receive this message in error, please notify the sender immediately and delete all copies of this message.