Branch: Tag:

2000-04-24

2000-04-24 22:46:22 by Kenneth Johansson <kenneth.johansson.home@gmail.com>

Added documentation for the throttle tag.

Rev: server/modules/throttling/throttletags.pike:1.7

5:   inherit "roxenlib";      constant thread_safe=1; - constant cvs_version="$Id: throttletags.pike,v 1.6 2000/04/14 22:34:07 per Exp $"; + constant cvs_version="$Id: throttletags.pike,v 1.7 2000/04/24 22:46:22 kuntri Exp $";      #ifdef THROTTLING_DEBUG   #undef THROTTLING_DEBUG
25: Inside #if defined(manual)
  #ifdef manual   constant tagdoc=(["throttle":#"<desc tag><short>This tag determines a request's allocated bandwidth.</short></desc>    - <attr name=''> + <attr name='not'> + Disables all and any throttling for the current request. Implies the + 'final' arg. + </attr>    -  + <attr name='add' value='rate'> + Adds 'rate' bytes/sec to the current rate for the current request. + </attr> +  + <attr name='subtract' value='rate'> + Subtracts 'rate' bytes/sec from the current rate for the current + request. + </attr> +  + <attr name='multiply' value='float'> + Multiplies this requests' bandwidth by 'float'. + </attr> +  + <attr name='divide' value='float'> + Divides this requests' bandwidth by 'float'. + </attr> +  + <attr name='rate' value='value'> + Sets this request's bandwidth to 'value'. + </attr> +  + <attr name='final' required> + No subsequent modifications will be done to this request's bandwidth + after the current one.   </attr>",      ]);