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

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::Service - Role implemented by all bot services

VERSION ^

version 0.142220

DESCRIPTION ^

All bot services must implement this role.

ATTRIBUTES ^

name

This is the name of the service configured for the bot. It will be unique for that bot.

bot

This is a back link to the Bot::Backbone::Bot that owns this service.

REQUIRED METHODS ^

initialize

This method will be called after construction, but before the event loop starts. This is where the service should initalize connections, prepare to receive messages, etc.

It will be passed no arguments.

METHODS ^

shutdown

This method will be called just before the bot destroys the service and exits. If called, your service is expected to terminate any pending jobs, kill any child processes, and clean up so that the bot will exit cleanly.

A default implementation is provided, which does nothing.

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: