Andrew Sterling Hanenkamp > Bot-Backbone > Bot::Backbone::Service::Role::Dispatch

Download:
Bot-Backbone-0.142220.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.142220   Source  

NAME ^

Bot::Backbone::Service::Role::Dispatch - Role for services that can perform dispatch

VERSION ^

version 0.142220

DESCRIPTION ^

Any service that can use a dispatcher employ this role to make that happen.

ATTRIBUTES ^

dispatcher_name

  dispatcher default => as {
      ...
  };

  service some_service => (
      service    => '=My::Service',
      dispatcher => 'default',
  );

During construction, this is named dispatcher. This is the name of the dispatcher to load from the bot during initialization.

dispatcher

  my $dispatcher = $service->dispatcher;

Do not set this attribute. It will be loaded using the "dispatcher_name" automatically. It returns a Bot::Bakcbone::Dispatcher object to use for dispatch.

A dispatch_message method is also delegated to the dispatcher.

commands

This is an optional setting for any dispatched service. Sometimes it is nice to use the same service more than once in a given context, but that does not work well when the service uses a fixed set of commands. This allows the commands to be remapped. It may also be that a user simply doesn't like the names originally chosen and this lets them change the names of any command.

This attribute takes a reference to a hash of strings which are used to remap the commands. The keys are the new commands to use and the values are the commands that should be replaced. A given command can only be renamed once.

For example,

  service roll => (
      service  => 'OFun::Roll',
      commands => {
          '!rolldice' => '!roll',
          '!flipcoin' => '!flip',
      },
  );

Using the Bot::Backbone::Service::OFun::Roll service, This would rename the !roll command to !rolldice and !flip to !flipcoin. In this case, using !roll in a chat with the bot would no longer have any effect on the service named "roll", but !rolldice would report the outcome of a dice roll.

If this does not provide enough flexibility, you can always go the route of completely replacing a service dispatcher with a new one (and you may want to check out "respond_by_service_method" in Bot::Backbone and "run_this_service_method" in Bot::Backbone for help doing that from the bot configuration). You can also define custom code to use "predicate_iterator" in Bot::Backbone::Dispatcher that walks the entire dispatcher tree and makes changes as needed, which is how this is implemented internally.

METHODS ^

BUILD

Rewrites the dispatcher according to the commands renamed in "commands".

dispatch_message

  $service->dispatch_message($message);

If the service has a dispatcher configured, this will call the "dispatch_message" in Bot::Backbone::Dispatcher method on the dispatcher.

initialize

Make sure the dispatcher is initialized by initialization.

AUTHOR ^

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Qubling Software LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: