irccd
3.0.3
|
Abstract plugin. More...
#include <plugin.hpp>
Public Types | |
using | map = std::unordered_map< std::string, std::string > |
Public Member Functions | |
plugin (std::string id) noexcept | |
virtual | ~plugin ()=default |
auto | get_id () const noexcept -> const std::string & |
virtual auto | get_name () const noexcept -> std::string_view=0 |
virtual auto | get_author () const noexcept -> std::string_view |
virtual auto | get_license () const noexcept -> std::string_view |
virtual auto | get_summary () const noexcept -> std::string_view |
virtual auto | get_version () const noexcept -> std::string_view |
virtual auto | get_options () const -> map |
virtual void | set_options (const map &map) |
virtual auto | get_templates () const -> map |
virtual void | set_templates (const map &map) |
virtual auto | get_paths () const -> map |
virtual void | set_paths (const map &map) |
virtual void | handle_command (bot &bot, const message_event &event) |
virtual void | handle_connect (bot &bot, const connect_event &event) |
virtual void | handle_disconnect (bot &bot, const disconnect_event &event) |
virtual void | handle_invite (bot &bot, const invite_event &event) |
virtual void | handle_join (bot &bot, const join_event &event) |
virtual void | handle_kick (bot &bot, const kick_event &event) |
virtual void | handle_load (bot &bot) |
virtual void | handle_message (bot &bot, const message_event &event) |
virtual void | handle_me (bot &bot, const me_event &event) |
virtual void | handle_mode (bot &bot, const mode_event &event) |
virtual void | handle_names (bot &bot, const names_event &event) |
virtual void | handle_nick (bot &bot, const nick_event &event) |
virtual void | handle_notice (bot &bot, const notice_event &event) |
virtual void | handle_part (bot &bot, const part_event &event) |
virtual void | handle_reload (bot &bot) |
virtual void | handle_topic (bot &bot, const topic_event &event) |
virtual void | handle_unload (bot &bot) |
virtual void | handle_whois (bot &bot, const whois_event &event) |
Abstract plugin.
A plugin is identified by name and can be loaded and unloaded at runtime.
using irccd::daemon::plugin::map = std::unordered_map<std::string, std::string> |
Map for key/value pairs.
Used in options, templates and paths.
|
noexcept |
Construct a plugin.
id | the plugin id |
|
virtualdefault |
Temporary, close all timers.
|
virtualnoexcept |
Get the author.
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
noexcept |
Get user unique id.
|
virtualnoexcept |
Get the license.
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
pure virtualnoexcept |
Get the plugin name.
Implemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
Get all options.
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
Get all paths.
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtualnoexcept |
Get the summary.
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
Get all templates.
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtualnoexcept |
Get the version.
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On channel message. This event will call onMessage or onCommand if the messages starts with the command character plus the plugin name.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On successful connection.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On disconnection.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On invitation.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On join.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On kick.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On load.
bot | the irccd instance |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
On CTCP Action.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On channel message.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On user mode change.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On names listing.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On nick change.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On user notice.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On part.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On reload.
bot | the irccd instance |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On topic change.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On unload.
bot | the irccd instance |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
On whois information.
bot | the irccd instance |
event | the event |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
Set all options.
map | the options |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
Set all paths.
map | the paths |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.
|
virtual |
Set all templates.
map | the templates |
Reimplemented in irccd::js::plugin, irccd::test::mock_plugin, and irccd::test::broken_plugin.