|
@@ -470,243 +470,6 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
|
|
|
</section>
|
|
|
</section>
|
|
|
|
|
|
- <section>
|
|
|
- <title>Exported MI Functions</title>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_stats</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Lists the parameters and variabiles in the ratelimit module.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_stats</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters: <emphasis>none</emphasis></para>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_stats:_reply_fifo_file_
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_set_pipe</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Sets the pipe parameters for the given pipe id.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_set_pipe</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters:</para>
|
|
|
- <itemizedlist>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>pipe_id</emphasis> - pipe id.
|
|
|
- </para></listitem>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>pipe_algorithm</emphasis> - the
|
|
|
- algorithm assigned to the given pipe id.
|
|
|
- </para></listitem>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>pipe_limit</emphasis> - the limit
|
|
|
- assigned to the given pipe id.
|
|
|
- </para></listitem>
|
|
|
- </itemizedlist>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_set_pipe:_reply_fifo_file_
|
|
|
- 2
|
|
|
- RED
|
|
|
- 10
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_get_pipes</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Gets the list of in use pipes.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_get_pipes</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters: <emphasis>none</emphasis></para>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_get_pipes:_reply_fifo_file_
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_set_queue</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Sets the queue parameters for the given queue id.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_set_queue</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters:</para>
|
|
|
- <itemizedlist>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>queue_id</emphasis> - queue id.
|
|
|
- </para></listitem>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>queue_method</emphasis> - the method
|
|
|
- assigned to the given queue id.
|
|
|
- </para></listitem>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>pipe_id</emphasis> - the pipe id
|
|
|
- assigned to the given queue id.
|
|
|
- </para></listitem>
|
|
|
- </itemizedlist>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_set_queue:_reply_fifo_file_
|
|
|
- 3
|
|
|
- INVITE
|
|
|
- 2
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_get_queues</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Gets the list of in use queues.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_get_queues</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters: <emphasis>none</emphasis></para>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_get_queues:_reply_fifo_file_
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_set_pid</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Sets the PID Controller parameters for the Feedback Algorithm.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_set_pid</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters:</para>
|
|
|
- <itemizedlist>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>ki</emphasis> - the integral parameter.
|
|
|
- </para></listitem>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>kp</emphasis> - the proportional parameter.
|
|
|
- </para></listitem>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>kd</emphasis> - the derivative parameter.
|
|
|
- </para></listitem>
|
|
|
- </itemizedlist>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_set_pid:_reply_fifo_file_
|
|
|
- 0.5
|
|
|
- 0.5
|
|
|
- 0.5
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_get_pid</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Gets the list of in use PID Controller parameters.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_get_pid</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters: <emphasis>none</emphasis></para>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_get_pid:_reply_fifo_file_
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_push_load</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Force the value of the load parameter. This methos is usefull
|
|
|
- for testing the Feedback algorithm.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_push_load</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters:</para>
|
|
|
- <itemizedlist>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>load</emphasis> - the forced value of load
|
|
|
- (it must be greater then 0.0 and smaller then 1.0).
|
|
|
- </para></listitem>
|
|
|
- </itemizedlist>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_push_load:_reply_fifo_file_
|
|
|
- 0.85
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">rl_set_dbg</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- This MI function will enable/disable a WARNING debug log exposing the
|
|
|
- internal counters for each pipe (useful in monitoring the ratelimit internals).
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Name: <emphasis>rl_set_dbg</emphasis>
|
|
|
- </para>
|
|
|
- <para>Parameters:</para>
|
|
|
- <itemizedlist>
|
|
|
- <listitem><para>
|
|
|
- <emphasis>dbg</emphasis> - the debug value (0 means disable and
|
|
|
- 1 means enable).
|
|
|
- </para></listitem>
|
|
|
- </itemizedlist>
|
|
|
- <para>
|
|
|
- MI FIFO Command Format:
|
|
|
- </para>
|
|
|
- <programlisting format="linespecific">
|
|
|
- :rl_set_dbg:_reply_fifo_file_
|
|
|
- 1
|
|
|
- _empty_line_
|
|
|
- </programlisting>
|
|
|
- </section>
|
|
|
- </section>
|
|
|
-
|
|
|
<section>
|
|
|
<title>Exported RPC Functions</title>
|
|
|
<section>
|