irc_connection.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#ifdef _MSC_VER
#pragma warning (disable:4786)
#endif

#include "../api_network.h"
#include "../../Core/Text/string_types.h"
#include <vector>
#include <list>
#include <queue>
#include "../../Core/Signals/signal_v1.h"
#include "../../Core/Signals/signal_v2.h"
#include "../../Core/Signals/signal_v3.h"
#include "../../Core/Signals/signal_v4.h"
#include "irc_numerics.h"

class CL_IRCConnection_Generic;

class CL_API_NETWORK CL_IRCConnection
{

public:
        CL_IRCConnection();

        CL_IRCConnection(const CL_String &server, const CL_String &port = cl_text("6667"));

        CL_IRCConnection(const CL_IRCConnection &copy);

        ~CL_IRCConnection();


public:
        const CL_String8 &get_nick() const;

        const CL_String8 &get_username() const;

        const CL_String8 &get_hostname() const;

        const CL_String8 &get_servername() const;

        const CL_String8 &get_realname() const;


public:
        CL_IRCConnection &operator =(const CL_IRCConnection &copy);

        void send_command(const CL_String8 &prefix, const CL_String8 &command, const std::vector<CL_String8> &params);

        void send_pass(const CL_String8 &password);

        void send_nick(const CL_String8 &nick, int hopcount = -1);

        void send_user(const CL_String8 &username, const CL_String8 &hostname, const CL_String8 &servername, const CL_String8 &realname);

        void send_oper(const CL_String8 &user, const CL_String8 &password);

        void send_quit(const CL_String8 &quitmessage = "");

        void send_join(const CL_String8 &channel, const CL_String8 &key = "");

        void send_join(const std::list<CL_String8> &channels, const std::list<CL_String8> &keys);

        void send_part(const CL_String8 &channel, const CL_String8 &reason = "");

        void send_part(const std::list<CL_String8> &channels, const CL_String8 &reason = "");

        void send_mode(const CL_String8 &target, const CL_String8 &mode, const std::vector<CL_String8> &args);

        void send_topic(const CL_String8 &channel, const CL_String8 &topic);

        void send_topic(const CL_String8 &channel);

        void send_names(const CL_String8 &channel = "");

        void send_names(const std::list<CL_String8> &channels);

        void send_list(const CL_String8 &channel = "", const CL_String8 &server = "");

        void send_list(const std::list<CL_String8> &channels, const CL_String8 &server = "");

        void send_invite(const CL_String8 &nickname, const CL_String8 &channel);

        void send_kick(const CL_String8 &channel, const CL_String8 &user, const CL_String8 &comment = "");

        void send_kick(const std::list<CL_String8> &channels, const std::list<CL_String8> &users, const CL_String8 &comment = "");

        void send_version(const CL_String8 &server = "");

        void send_stats(const CL_String8 &query = "", const CL_String8 &server = "");

        void send_links(const CL_String8 &remote_server = "", const CL_String8 &server_mask = "");

        void send_time(const CL_String8 &server = "");

        void send_connect(const CL_String8 &target_server, int port = 0, const CL_String8 &remote_server = "");

        void send_trace(const CL_String8 &server = CL_String8());

        void send_admin(const CL_String8 &server = CL_String8());

        void send_info(const CL_String8 &server = CL_String8());

        void send_privmsg(const CL_String8 &receiver, const CL_String8 &text);

        void send_privmsg(const std::list<CL_String8> &receivers, const CL_String8 &text);

        void send_privmsg_ctcp(const CL_String8 &receiver, const CL_String8 &command, const CL_String8 &data);

        void send_privmsg_ctcp(std::list<CL_String8> &receivers, const CL_String8 &command, const CL_String8 &data);

        void send_notice(const CL_String8 &nickname, const CL_String8 &text);

        void send_notice_ctcp(const CL_String8 &nickname, const CL_String8 &command, const CL_String8 &data);

        void send_who(const CL_String8 &name, bool oper = false);

        void send_whois(const CL_String8 &nickmask);

        void send_whois(const CL_String8 &server, const CL_String8 &nickmask);

        void send_whois(const std::list<CL_String8> &nickmasks);

        void send_whois(const CL_String8 &server, const std::list<CL_String8> &nickmasks);

        void send_whowas(const CL_String8 &nickname, int count = 0, const CL_String8 &server = "");

        void send_kill(const CL_String8 &nickname, const CL_String8 &comment);

        void send_ping(const CL_String8 &server, const CL_String8 &server2 = "");

        void send_pong(const CL_String8 &daemon, const CL_String8 &daemon2 = "");

        static CL_String8 extract_nick(const CL_String8 &str);

        static CL_String8 extract_user(const CL_String8 &str);

        static CL_String8 extract_address(const CL_String8 &str);


public:
        CL_Signal_v1<const CL_String &> &sig_socket_error();

        CL_Signal_v3<const CL_String8 &, const CL_String8 &, const std::vector<CL_String8> &> &sig_command_received();

        CL_Signal_v3<const CL_String8 &, const CL_String8 &, const std::vector<CL_String8> &> &sig_unknown_command_received();

        CL_Signal_v3<const CL_String8 &, int, const std::vector<CL_String8> &> &sig_numeric_reply();

        CL_Signal_v3<const CL_String8 &, const CL_String8 &, const std::vector<CL_String8> &> &sig_name_reply();

        CL_Signal_v2<const CL_String8 &, const CL_String8 &> &sig_nick();

        CL_Signal_v2<const CL_String8 &, const CL_String8 &> &sig_join();

        CL_Signal_v3<const CL_String8 &, const CL_String8 &, const CL_String8 &> &sig_part();

        CL_Signal_v4<const CL_String8 &, const CL_String8 &, const CL_String8 &, const std::vector<CL_String8> &> &sig_mode();

        CL_Signal_v3<const CL_String8 &, const CL_String8 &, const CL_String8 &> &sig_topic();

        CL_Signal_v3<const CL_String8 &, const CL_String8 &, const CL_String8 &> &sig_invite();

        CL_Signal_v4<const CL_String8 &, const CL_String8 &, const CL_String8 &, const CL_String8 &> &sig_kick();

        CL_Signal_v3<const CL_String8 &, const CL_String8 &, const CL_String8 &> &sig_privmsg();

        CL_Signal_v3<const CL_String8 &, const CL_String8 &, const CL_String8 &> &sig_notice();

        CL_Signal_v4<const CL_String8 &, const CL_String8 &, const CL_String8 &, const CL_String8 &> &sig_privmsg_ctcp();

        CL_Signal_v4<const CL_String8 &, const CL_String8 &, const CL_String8 &, const CL_String8 &> &sig_notice_ctcp();

        CL_Signal_v2<const CL_String8 &, const CL_String8 &> &sig_ping();


private:
        CL_SharedPtr<CL_IRCConnection_Generic> impl;
};

---