protocol.h

/*
 * InspIRCd -- Internet Relay Chat Daemon
 *
 *   Copyright (C) 2018 Matt Schatz <[email protected]>
 *   Copyright (C) 2013-2014 Attila Molnar <[email protected]>
 *   Copyright (C) 2013, 2018-2019 Sadie Powell <[email protected]>
 *   Copyright (C) 2012, 2019 Robby <[email protected]>
 *   Copyright (C) 2008, 2010 Craig Edwards <[email protected]>
 *   Copyright (C) 2008 Robin Burchell <[email protected]>
 *
 * This file is part of InspIRCd.  InspIRCd is free software: you can
 * redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation, version 2.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
#include "hashcomp.h"
 
class User;
 
class ProtocolServer
{
 public:
        virtual void SendMetaData(const std::string& key, const std::string& data) = 0;
};
 
class CoreExport ProtocolInterface
{
 public:
        typedef ProtocolServer Server;
 
        class ServerInfo
        {
         public:
                std::string servername;
                std::string parentname;
                std::string description;
                unsigned int usercount;
                unsigned int opercount;
                unsigned int latencyms;
        };
 
        typedef std::vector<ServerInfo> ServerList;
 
        virtual ~ProtocolInterface() { }
 
        virtual bool SendEncapsulatedData(const std::string& targetmask, const std::string& cmd, const CommandBase::Params& params, User* source = NULL) { return false; }
 
        virtual void BroadcastEncap(const std::string& cmd, const CommandBase::Params& params, User* source = NULL, User* omit = NULL) { }
 
        virtual void SendMetaData(Channel* chan, const std::string& key, const std::string& data) { }
 
        virtual void SendMetaData(User* user, const std::string& key, const std::string& data) { }
 
        virtual void SendMetaData(const std::string& key, const std::string& data) { }
 
        virtual void SendSNONotice(char snomask, const std::string& text) { }
 
        virtual void SendMessage(Channel* target, char status, const std::string& text, MessageType type = MSG_PRIVMSG) { }
 
        virtual void SendMessage(User* target, const std::string& text, MessageType type = MSG_PRIVMSG) { }
 
        DEPRECATED_METHOD(void SendChannelNotice(Channel* target, char status, const std::string& text))
        {
                SendMessage(target, status, text, MSG_NOTICE);
        }
 
        DEPRECATED_METHOD(void SendUserNotice(User* target, const std::string& text))
        {
                SendMessage(target, text, MSG_NOTICE);
        }
 
        virtual void GetServerList(ServerList& sl) { }
};