irccd  3.0.3
Public Member Functions | List of all members
irccd::test::mock_plugin Class Reference

Mock plugin. More...

#include <mock_plugin.hpp>

Inheritance diagram for irccd::test::mock_plugin:
irccd::daemon::plugin irccd::test::mock

Public Member Functions

auto get_name () const noexcept -> std::string_view override
 
auto get_author () const noexcept -> std::string_view override
 
auto get_license () const noexcept -> std::string_view override
 
auto get_summary () const noexcept -> std::string_view override
 
auto get_version () const noexcept -> std::string_view override
 
auto get_options () const -> map override
 
void set_options (const map &map) override
 
auto get_templates () const -> map override
 
void set_templates (const map &map) override
 
auto get_paths () const -> map override
 
void set_paths (const map &map) override
 
void handle_command (daemon::bot &bot, const daemon::message_event &event) override
 
void handle_connect (daemon::bot &bot, const daemon::connect_event &event) override
 
void handle_disconnect (daemon::bot &bot, const daemon::disconnect_event &event) override
 
void handle_invite (daemon::bot &bot, const daemon::invite_event &event) override
 
void handle_join (daemon::bot &bot, const daemon::join_event &event) override
 
void handle_kick (daemon::bot &bot, const daemon::kick_event &event) override
 
void handle_load (daemon::bot &bot) override
 
void handle_message (daemon::bot &bot, const daemon::message_event &event) override
 
void handle_me (daemon::bot &bot, const daemon::me_event &event) override
 
void handle_mode (daemon::bot &bot, const daemon::mode_event &event) override
 
void handle_names (daemon::bot &bot, const daemon::names_event &event) override
 
void handle_nick (daemon::bot &bot, const daemon::nick_event &event) override
 
void handle_notice (daemon::bot &bot, const daemon::notice_event &event) override
 
void handle_part (daemon::bot &bot, const daemon::part_event &event) override
 
void handle_reload (daemon::bot &bot) override
 
void handle_topic (daemon::bot &bot, const daemon::topic_event &event) override
 
void handle_unload (daemon::bot &bot) override
 
void handle_whois (daemon::bot &bot, const daemon::whois_event &event) override
 
- Public Member Functions inherited from irccd::daemon::plugin
 plugin (std::string id) noexcept
 
virtual ~plugin ()=default
 
auto get_id () const noexcept -> const std::string &
 
- Public Member Functions inherited from irccd::test::mock
void push (std::string name, args args={}) const
 
auto find (const std::string &name) const -> std::vector< args >
 
void clear (const std::string &name) const noexcept
 
void clear () const noexcept
 
auto empty () const noexcept -> bool
 

Additional Inherited Members

- Public Types inherited from irccd::daemon::plugin
using map = std::unordered_map< std::string, std::string >
 
- Public Types inherited from irccd::test::mock
using args = std::vector< std::any >
 Functions arguments. More...
 
using functions = std::unordered_map< std::string, std::vector< args > >
 Map of all functions. More...
 

Detailed Description

Mock plugin.

Member Function Documentation

◆ get_author()

auto irccd::test::mock_plugin::get_author ( ) const -> std::string_view
overridevirtualnoexcept

Get the author.

Returns
the author

Reimplemented from irccd::daemon::plugin.

◆ get_license()

auto irccd::test::mock_plugin::get_license ( ) const -> std::string_view
overridevirtualnoexcept

Get the license.

Returns
the license

Reimplemented from irccd::daemon::plugin.

◆ get_name()

auto irccd::test::mock_plugin::get_name ( ) const -> std::string_view
overridevirtualnoexcept

Get the plugin name.

Returns
the plugin name

Implements irccd::daemon::plugin.

◆ get_options()

auto irccd::test::mock_plugin::get_options ( ) const -> map
overridevirtual

Get all options.

Returns
options

Reimplemented from irccd::daemon::plugin.

◆ get_paths()

auto irccd::test::mock_plugin::get_paths ( ) const -> map
overridevirtual

Get all paths.

Returns
paths

Reimplemented from irccd::daemon::plugin.

◆ get_summary()

auto irccd::test::mock_plugin::get_summary ( ) const -> std::string_view
overridevirtualnoexcept

Get the summary.

Returns
the summary

Reimplemented from irccd::daemon::plugin.

◆ get_templates()

auto irccd::test::mock_plugin::get_templates ( ) const -> map
overridevirtual

Get all templates.

Returns
the templates

Reimplemented from irccd::daemon::plugin.

◆ get_version()

auto irccd::test::mock_plugin::get_version ( ) const -> std::string_view
overridevirtualnoexcept

Get the version.

Returns
the version

Reimplemented from irccd::daemon::plugin.

◆ handle_command()

void irccd::test::mock_plugin::handle_command ( daemon::bot bot,
const daemon::message_event event 
)
overridevirtual

On channel message. This event will call onMessage or onCommand if the messages starts with the command character plus the plugin name.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_connect()

void irccd::test::mock_plugin::handle_connect ( daemon::bot bot,
const daemon::connect_event event 
)
overridevirtual

On successful connection.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_disconnect()

void irccd::test::mock_plugin::handle_disconnect ( daemon::bot bot,
const daemon::disconnect_event event 
)
overridevirtual

On disconnection.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_invite()

void irccd::test::mock_plugin::handle_invite ( daemon::bot bot,
const daemon::invite_event event 
)
overridevirtual

On invitation.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_join()

void irccd::test::mock_plugin::handle_join ( daemon::bot bot,
const daemon::join_event event 
)
overridevirtual

On join.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_kick()

void irccd::test::mock_plugin::handle_kick ( daemon::bot bot,
const daemon::kick_event event 
)
overridevirtual

On kick.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_load()

void irccd::test::mock_plugin::handle_load ( daemon::bot bot)
overridevirtual

On load.

Parameters
botthe irccd instance

Reimplemented from irccd::daemon::plugin.

◆ handle_me()

void irccd::test::mock_plugin::handle_me ( daemon::bot bot,
const daemon::me_event event 
)
overridevirtual

On CTCP Action.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_message()

void irccd::test::mock_plugin::handle_message ( daemon::bot bot,
const daemon::message_event event 
)
overridevirtual

On channel message.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_mode()

void irccd::test::mock_plugin::handle_mode ( daemon::bot bot,
const daemon::mode_event event 
)
overridevirtual

On user mode change.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_names()

void irccd::test::mock_plugin::handle_names ( daemon::bot bot,
const daemon::names_event event 
)
overridevirtual

On names listing.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_nick()

void irccd::test::mock_plugin::handle_nick ( daemon::bot bot,
const daemon::nick_event event 
)
overridevirtual

On nick change.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_notice()

void irccd::test::mock_plugin::handle_notice ( daemon::bot bot,
const daemon::notice_event event 
)
overridevirtual

On user notice.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_part()

void irccd::test::mock_plugin::handle_part ( daemon::bot bot,
const daemon::part_event event 
)
overridevirtual

On part.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_reload()

void irccd::test::mock_plugin::handle_reload ( daemon::bot bot)
overridevirtual

On reload.

Parameters
botthe irccd instance

Reimplemented from irccd::daemon::plugin.

◆ handle_topic()

void irccd::test::mock_plugin::handle_topic ( daemon::bot bot,
const daemon::topic_event event 
)
overridevirtual

On topic change.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ handle_unload()

void irccd::test::mock_plugin::handle_unload ( daemon::bot bot)
overridevirtual

On unload.

Parameters
botthe irccd instance

Reimplemented from irccd::daemon::plugin.

◆ handle_whois()

void irccd::test::mock_plugin::handle_whois ( daemon::bot bot,
const daemon::whois_event event 
)
overridevirtual

On whois information.

Parameters
botthe irccd instance
eventthe event

Reimplemented from irccd::daemon::plugin.

◆ set_options()

void irccd::test::mock_plugin::set_options ( const map map)
overridevirtual

Set all options.

Parameters
mapthe options

Reimplemented from irccd::daemon::plugin.

◆ set_paths()

void irccd::test::mock_plugin::set_paths ( const map map)
overridevirtual

Set all paths.

Parameters
mapthe paths

Reimplemented from irccd::daemon::plugin.

◆ set_templates()

void irccd::test::mock_plugin::set_templates ( const map map)
overridevirtual

Set all templates.

Parameters
mapthe templates

Reimplemented from irccd::daemon::plugin.


The documentation for this class was generated from the following file: