From 5a9d8634e742fe28b3b5c733b9e727b1dc7917ce Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Wed, 1 Mar 2023 13:29:47 +0100 Subject: [PATCH] rtpengine: docs for SDES-nonew and SDES-pad flags - spell fixes --- src/modules/rtpengine/doc/rtpengine_admin.xml | 36 +++++++++++++------ 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/src/modules/rtpengine/doc/rtpengine_admin.xml b/src/modules/rtpengine/doc/rtpengine_admin.xml index 1d5ad124772..ba6e9f2d22b 100644 --- a/src/modules/rtpengine/doc/rtpengine_admin.xml +++ b/src/modules/rtpengine/doc/rtpengine_admin.xml @@ -81,7 +81,7 @@ There is no locking when setting the nodes enabled/disabled (to keep the memory access as fast as possible). Thus, problems related to node state might appear for concurrent processes that might set the nodes - enabled/disabled(e.g. by fifo command). These robustness problems are overcome as follows. + enabled/disabled (e.g. by fifo command). These robustness problems are overcome as follows. @@ -120,6 +120,8 @@ tm module - (optional) if you want to have rtpengine_manage() fully functional + + lwsc module - (optional) if you plan to use wsapi parameter @@ -266,7 +268,7 @@ modparam("rtpengine", "rtpengine_tout_ms", 2000) Enable this setting to allow finishing the current sessions while denying new sessions for deactivated nodes. Nodes can be manually deactivated via kamctl command i.e. "disabled(permanent)" nodes. - Probably the manually deactivated machine is still running(did not crash). + Probably the manually deactivated machine is still running (did not crash). This is useful when deactivating a node for maintenance and @@ -534,7 +536,7 @@ modparam("rtpengine", "hash_table_size", 123) NOTE: When configuring this parameter, one should consider maximum call time - VS share memory for unfinished calls. + VS shared memory for unfinished calls. Set <varname>hash_table_tout</varname> parameter @@ -758,8 +760,8 @@ modparam("rtpengine", "media_duration", "$avp(MEDIA_DURATION)")
<varname>mos_min_pv</varname> (string) - The name of a pseudovariable to hold the minimum encountered MOS value for the call. - The value typically has a range of 1.0 through 5.0. + The name of a pseudovariable to hold the minimum encountered MOS (Mean Opinion + Score) value for the call. The value typically has a range of 1.0 through 5.0. There is no default value. @@ -2211,9 +2213,9 @@ modparam("rtpengine", "control_cmd_tos", 144)
<varname>hash_algo</varname> (integer) - Hashing algorithm to be used in node selection algorithm. Now there are 2 possibilities: legacy - algorithm - 0(very basic hash over callid), SHA1 - 1(apply sha1 over the callid and calculate hash) or - CRC32 - 2(calculate crc32 sum over the callid). + Hashing algorithm to be used in node selection algorithm. Now there are 3 possibilities: legacy + algorithm - 0 (very basic hash over callid), SHA1 - 1 (apply sha1 over the callid and calculate hash) or + CRC32 - 2 (calculate crc32 sum over the callid). Default value is 0, legacy algorithm. @@ -2407,7 +2409,7 @@ rtpengine_offer(); force - instructs the &rtp; proxy to ignore marks inserted by another &rtp; proxy in transit to indicate that the - session is already goes through another proxy. Allows creating + session already goes through another proxy. Allows creating a chain of proxies. Not supported and ignored by Sipwise rtpengine. @@ -2586,6 +2588,18 @@ rtpengine_offer(); if accepting these parameters is not desired and they should be rejected instead. + SDES-nonew - don't add any new crypto suites into the offer. + This means, offered SDES crypto suites will be accepted, meanwhile no new is going + to be generated by RTPEngine. It takes precedence over the `SDES-no` and `SDES-only` + flags, if used in combination. + + + SDES-pad - RFC 4568 (section 6.1) is somewhat ambiguous regarding + the base64 encoding format of `a=crypto` parameters added to an SDP body. The default + interpretation is that trailing `=` characters used for padding should be omitted. With + this flag set, these padding characters will be left in place. + + unidirectional - allows kernelization of one-way streams in the Sipwise rtpengine proxy. This is especially useful when the first call leg is handled by some rtpengine machine while the second call leg is handled by other rtpengine machine. @@ -2643,7 +2657,7 @@ rtpengine_offer(); T.38=decode - If the offered &sdp; contains a media section advertising T.38 over UDPTL, translate it to a regular audio media section over RTP. By default, PCMU and PCMA will be used as audio codecs, but that can - be overriden using the codec options described above. Other transport protocols + be overridden using the codec options described above. Other transport protocols (e.g. SRTP) can also be selected in the same way. If the offered &sdp; does not contain a T.38 section, then this flag has no effect. @@ -3365,7 +3379,7 @@ $ &kamcmd; rtpengine.reload Displays success or fail when try to enable/disable. - NOTE: If a &rtp; proxy is defined multiple times (in the same or diferent sets), all of its instances will be enabled/disabled. + NOTE: If a &rtp; proxy is defined multiple times (in the same or different sets), all of its instances will be enabled/disabled. NOTE: If a &rtp; proxy is in the disabled permanent state and one tries to enable it, even if the ping fails,