irccd  3.0.3
Public Member Functions | List of all members
irccd::daemon::server_kick_command Class Reference

Implementation of server-kick transport command. More...

#include <transport_command.hpp>

Inheritance diagram for irccd::daemon::server_kick_command:
irccd::daemon::transport_command

Public Member Functions

auto get_name () const noexcept -> std::string_view override
 
void exec (bot &bot, transport_client &client, const document &args) override
 
- Public Member Functions inherited from irccd::daemon::transport_command
virtual ~transport_command ()=default
 

Additional Inherited Members

- Public Types inherited from irccd::daemon::transport_command
using document = json_util::deserializer
 Convenient alias. More...
 
using constructor = std::function< std::unique_ptr< transport_command >()>
 Command constructor factory. More...
 
- Static Public Member Functions inherited from irccd::daemon::transport_command
static auto registry () noexcept -> const std::vector< constructor > &
 Registry of all commands. More...
 

Detailed Description

Implementation of server-kick transport command.

Replies:

Member Function Documentation

◆ exec()

void irccd::daemon::server_kick_command::exec ( bot bot,
transport_client client,
const document args 
)
overridevirtual

Execute the command.

If the command throw an exception, the error is sent to the client so be careful about sensitive information.

The implementation should use client.success() or client.error() to send some data.

Parameters
botthe irccd instance
clientthe client
argsthe client arguments

Implements irccd::daemon::transport_command.

◆ get_name()

auto irccd::daemon::server_kick_command::get_name ( ) const -> std::string_view
overridevirtualnoexcept

Return the command name, must not have spaces.

Returns
the command name

Implements irccd::daemon::transport_command.


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