ircproxy  The Ultimate Cyborg

---

NickPair.h

Go to the documentation of this file.

// ircproxy -- An intelligent IRC proxy
//
//! @file NickPair.h
//! @brief Header of class NickPair
//
// Copyright (C) 2005 - 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 NICKPAIR_H
#define NICKPAIR_H

#ifndef USE_PCH
#include <iosfwd>
#include <string>
#include <deque>
#endif

//! @brief An input/output nick pair.
//
// When a client changes nick, it has temporarily two nicks: the new one
// for subsequent messages from the client, and the old one for incoming
// messages from the server, until a NICK newnick from the server is
// received. This class keeps track of both nicks.
class NickPair {
  private:
    std::ostream& M_session;                    //!< The socket for which this nick pair is being kept.
    std::string M_in_nick;                      //!< The last NICK received from the socket.
    std::string M_out_nick;                     //!< The last NICK sent to the socket.
    std::deque<std::string> M_out_nicks;        //!< Unconfirmed outgoing nicks.

  public:
    //! Create a NickPair instance for the session \a session.
    NickPair(std::ostream& session) : M_session(session) { }

    void send_nick(std::string const& nick);    // Write NICK immediately to the socket.
    bool nick_received(std::string const& nick);// A new NICK was received from the socket.
    void inuse(std::string const& nick);        // The requested nick change was refused.

    //! Returns the last NICK received.
    std::string const& in_nick(void) const { return M_in_nick; }

    //! Returns the last NICK sent.
    std::string const& out_nick(void) const { return M_out_nick; }
};

#endif // NICKPAIR_H

---