Maiden-Activatable

About

This agent provides handlers that can be de/activated on a per-client/channel basis. This means that handlers, which provide passive reactions not based on commands can be managed with this.

How To

In order to define a handler that can be de/activated, you must set activatable-handler as its superclass and pass the body option :module. An example, for a fictitious beer agent it might look as follows:

(define-handler (beer give-beer message-event) (c ev message)
  :class activatable-handler
  :module #.*package*
  (when (search "I'm thirsty" message)
    (reply ev "Have a beer! c(%)")))

We're passing the file's package at read-time here, which is a bit more comfortable than passing the name of the package explicitly. Henceforth the handler can be de/activated using the appropriate functions or commands and the package name.

Copyright

maiden-activatable 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-ACTIVATABLE (ORG.SHIRAKUMO.MAIDEN.AGENTS.ACTIVATABLE)

class

`ACTIVATABLE`

This agent manages the activation of other agents that might want to be blocked on certain channels to avoid unwanted responses.

class

`ACTIVATABLE-HANDLER`

Mixin class for a handler that can be de/activated on a client/channel basis.

You must pass the name of the module the handler should
belong to as an initarg.

See MODULE
See ACTIVATE
See DEACTIVATE
See ACTIVE-P

class
ACTIVATE
```
 
```
class
DEACTIVATE
```
 
```
class
LIST-ACTIVE
```
 
```

function (

`ACTIVATE`

IDENT &REST MODULES)

Activate the modules on the given client ident.

See NORMALIZE-IDENT
See NORMALIZE-MODULE-NAME

function (

`ACTIVE-P`

IDENT MODULE)

Returns whether the given module is active on the given ident.

See NORMALIZE-IDENT
See NORMALIZE-MODULE-NAME

function (

`DEACTIVATE`

IDENT &REST MODULES)

Deactivate the modules on the given client ident.

See NORMALIZE-IDENT
See NORMALIZE-MODULE-NAME

function (

`LIST-ACTIVE`

IDENT)

Lists all active modules for the given ident.

See NORMALIZE-IDENT

command (

`activate`

&REST MODULES)

Activate modules on the current channel. By default modules are deactivated.

command (

`deactivate`

&REST MODULES)

Deactivate modules on the current channel.

command
list active
```
 
```