PandoraBotIRC  1.0.0
An irc bot that acts as a Pandora chatter bot
Public Member Functions | List of all members
pbirc::irc::IRCBot Class Referenceabstract

Abstract base class representing an IRC bot. More...

#include <IRCBot.hpp>

Inheritance diagram for pbirc::irc::IRCBot:
pbirc::irc::PandoraIRCBot

Public Member Functions

 IRCBot ()=default
 Default constructor. More...
 
virtual ~IRCBot ()=default
 Virtual default destructor. More...
 
virtual bool connect ()=0
 esponsible for connecting to the irc server and starting up the bot. More...
 
virtual void disconnect ()=0
 Responsible for disconnecting from the server and stopping the bot. More...
 
virtual int run ()=0
 Worker function for the bot. Responsible for doing everything else that the bot should do. More...
 

Detailed Description

Abstract base class representing an IRC bot.

Has three functions that base classes must overload: connect() disconnect() run()

Constructor & Destructor Documentation

pbirc::irc::IRCBot::IRCBot ( )
default

Default constructor.

virtual pbirc::irc::IRCBot::~IRCBot ( )
virtualdefault

Virtual default destructor.

Member Function Documentation

virtual bool pbirc::irc::IRCBot::connect ( )
pure virtual

esponsible for connecting to the irc server and starting up the bot.

Implemented in pbirc::irc::PandoraIRCBot.

virtual void pbirc::irc::IRCBot::disconnect ( )
pure virtual

Responsible for disconnecting from the server and stopping the bot.

Implemented in pbirc::irc::PandoraIRCBot.

virtual int pbirc::irc::IRCBot::run ( )
pure virtual

Worker function for the bot. Responsible for doing everything else that the bot should do.

Implemented in pbirc::irc::PandoraIRCBot.

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