Maiden-Throttle

About

This agent provides throttling on the users. This prevents them from overloading or spamming the services provided through commands and minimises the risk of exposing the bot to lots of users. The behaviour of the throttling can be customised rather precisely.

As soon as the throttling agent is put on a core, it will automatically record the usage stats of each user and throttle their commands at appropriate times. The few commands seen in the symbol index allow the management of the throttling configuration.

Copyright

maiden-throttle is licensed under the Artistic license. © Nicolas Hafner <shinmera@tymoon.eu> . This library can be obtained on https://github.com/Shinmera/maiden.

Package Index

MAIDEN-THROTTLE (ORG.SHIRAKUMO.MAIDEN.AGENTS.THROTTLE)

class
CLEAR-TAX
```
 
```

class

`RECORD`

Container class to hold information about the throttling of a user.

See ATTEMPTS
See TIMESTAMP
See TIMEOUT

class
SET-CONFIG
```
 
```

class

`THROTTLE`

Provides throttling to prevent spamming the bot with commands.

class
VIEW-CONFIG
```
 
```

accessor (

`ATTEMPTS`

OBJECT)

The current number of attempts that have been made by the user within the time-frame.

See RECORD

accessor (

`COOLDOWN-FUNCTION`

OBJECT)

Accessor to the symbol that designates a cooldown function used to calculate the number of seconds until the user is freed.

Must be one of the following:
- :CONSTANT     The cooldown is as much as the cooldown step.
- :LINEAR       The cooldown is increased linearly for each
                additional attempt within the cooldown.
- :EXPONENTIAL  The cooldown is increased exponentially for
                each additional attempt within the cooldown.

See THROTTLE
See COOLDOWN-STEP
See COOLDOWN-MAX

accessor (

`COOLDOWN-MAX`

OBJECT)

Accessor to the maximum amount of seconds that the user can be held in cooldown.

See THROTTLE
See COOLDOWN-FUNCTION
See COOLDOWN-STEP

accessor (

`COOLDOWN-STEP`

OBJECT)

Accessor to the step used to increase the cooldown according to the cooldown function.

See THROTTLE
See COOLDOWN-FUNCTION
See COOLDOWN-MAX

accessor (

`RECORD`

USER THROTTLE)

Access the throttling record for the given user.

See RECORDS
See THROTTLE

accessor (

`RECORDS`

OBJECT)

Accessor to the hash table associating user names to throttling records.

See THROTTLE
See RECORD

accessor (

`TIME-FRAME`

OBJECT)

Accessor to the number of seconds that specify a time-frame for throttling.

See THROTTLE
See ATTEMPTS

accessor (

`TIMEOUT`

OBJECT)

The number of seconds for which the user has been timed out. 

This is relative to TIMESTAMP.

See RECORD

accessor (

`TIMESTAMP`

OBJECT)

The universal-time timestamp that specifies the time at which the timeframe began or the timeout began.

See RECORD

generic (

`CLEAR-TAX`

USER THROTTLE)

Clear the tax on the user's record.

This effectively makes them unthrottled.

See RECORD

generic (

`TAX`

USER THROTTLE)

This function taxes the user for one attempt.

If too many attempts have been made too quickly, the user is
timed out. If further attempts are made while timed out, the
timeout is increased gradually according to the throttle's
timeout function and step. Once the user has passed their
timeout, the tax is cleared again.

See THROTTLE
See RECORD

command (
clear throttling for
USER &KEY CLIENT)
```
Clear the throttling tax from a user.
```
command (
set throttle configuration
&KEY ATTEMPTS TIME-FRAME COOLDOWN-FUNCTION COOLDOWN-STEP COOLDOWN-MAX)
```
Update the configuration values for the throttling behaviour.
```

command

`view throttle configuration`

Shows the current configuration that the throttling works with.

maiden-throttle

About

Copyright

Package Index

MAIDEN-THROTTLE (ORG.SHIRAKUMO.MAIDEN.AGENTS.THROTTLE)

`CLEAR-TAX`

`RECORD`

`SET-CONFIG`

`THROTTLE`

`VIEW-CONFIG`

`ATTEMPTS`

`COOLDOWN-FUNCTION`

`COOLDOWN-MAX`

`COOLDOWN-STEP`

`RECORD`

`RECORDS`

`TIME-FRAME`

`TIMEOUT`

`TIMESTAMP`

`CLEAR-TAX`

`TAX`

`clear throttling for`

`set throttle configuration`

`view throttle configuration`