ircproxy  The Ultimate Cyborg

---

NoticeTarget.h

Go to the documentation of this file.

// ircproxy -- An IRC bouncer.
//
//! @file NoticeTarget.h
//! @brief This file contains the declaration of class NoticeTarget.
//
// Copyright (C) 2006, 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 NOTICETARGET_H
#define NOTICETARGET_H

#ifndef USE_PCH
#include <string>
#include "debug.h"
#endif

#include "PrivateTarget.h"

class ClientMessageIn;

/*! @brief A fake channel that is used for communication between user and ircproxy.
 *
 * This class is used to send notices to the user.
 */
class NoticeTarget : public PrivateTarget {
  private:
    std::string M_notice;       //!< The notice to send.

  public:
  //! Construct a NoticeTarget instance for client session \a client_session with target name \a target_name on network \a network.
  NoticeTarget(ClientSession& client_session, std::string const& target_name, Network& network) :
      PrivateTarget(client_session, target_name, network)
      { Dout(dc::objects, "Constructing NoticeTarget(" <<
          client_session << ", \"" << target_name << "\", " << network << ")"); }
#ifdef CWDEBUG
  //! Destructor.
  ~NoticeTarget() { Dout(dc::objects, "Destructing NoticeTarget " << *this); }
  //! Copy-constructor.
  NoticeTarget(NoticeTarget const& notice_target) : PrivateTarget(notice_target)
      { Dout(dc::objects, "Copy-constructing NoticeTarget from " << notice_target); }
#endif

    // Called when a new message is received.
    virtual void new_client_message_received(ClientMessageIn const& msg);

  protected:
    //! The channel modes for this target, as sent to the client.
    virtual char const* channel_modes(void) { return "mnt"; }
};

#endif // NOTICETARGET_H

---