ircproxy  The Ultimate Cyborg

---

ISupport.h

Go to the documentation of this file.

// ircproxy -- An intelligent IRC proxy
//
//! @file ISupport.h
//! @brief Header of class ISupport
//
// Copyright (C) 2007 by
//
// Carlo Wood, Run on IRC <carlo@alinoe.com>
// RSA-1024 0x624ACAD5 1997-01-26                    Sign & Encrypt
// Fingerprint16 = 32 EC A7 B6 AC DB 65 A6  F6 F6 55 DD 1C DC FF 61
//
// This file may be distributed under the terms of the Q Public License
// version 1.0 as appearing in the file LICENSE.QPL included in the
// packaging of this file.

#ifndef ISUPPORT_H
#define ISUPPORT_H

#ifndef USE_PCH
#include <string>
#endif

#include "IdentityReference.h"

//! Stores the ISUPPORT reply (005) key/value pairs of the network.
class ISupport {
  public:
    //! The type of M_key_value_map.
    typedef std::map<std::string, std::string> key_value_map_type;

  private:
    ServerConnection& M_server_connection;      //!< Reference to the underlying server connection.
    key_value_map_type M_key_value_map;         //!< The map storing all numeric 005 key/value pairs.

  public:
    ISupport(ServerConnection& server_connection) : M_server_connection(server_connection) { }

    //! This function is called when a new connection is initiated (when receiving numeric 004).
    void begin(void);
    //! This function is called as soon as possible after the last 005 message is received.
    void end(void);
    //! This function is called for every "key=value" pair in each 005 message.
    void add(std::string const& param);
    //! If \a key exists, returns true and writes the corresponding value to \a value, otherwise returns false.
    bool get(std::string const& key, std::string& value);
};

#endif // ISUPPORT_H

---