ircproxy  The Ultimate Cyborg

---

Queue.h

Go to the documentation of this file.

// ircproxy -- An IRC bouncer.
//
//! @file Queue.h
//! @brief This file contains the declaration of class Queue.
//
// 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 QUEUE_H
#define QUEUE_H

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

#include "MessageOut.h"
#include "IdentityReference.h"

//! @brief A queue for messages to be sent to the server.
//
// Every second M_messages_per_second can be sent.
// This is achieved by incrementing M_free_messages with elapsed_seconds * M_messages_per_second,
// with an upper limit of M_max_free_messages.
// Each time a message is sent, M_free_messages is decremented with one.
class Queue : public virtual event_client_ct {
  public:
    //! The type of the outgoing messages queue.
    typedef std::priority_queue<MessageOut, std::deque<MessageOut> > priority_queue_type;

  private:
    ServerConnection& M_server_connection;                      //!< Reference to the underlying server connection.
    priority_queue_type M_priority_queue;                       //!< A queue for output messages, sorted by priority, that are waiting to be sent.
    float const M_messages_per_second;                          //!< The maximum average number of messages per second that can be sent to the server.
    unsigned int const M_max_free_messages;                     //!< The maximum number of message that can be sent in a single burst to the server.
    float M_free_messages;                                      //!< The current number of messages that can be sent in a single burst.
    timeval M_time;                                             //!< The last time that M_free_messages was updated.

  public:
    //! Construct a Queue object.
    Queue(ServerConnection& server_connection, float messages_per_second, unsigned int max_free_messages, unsigned int initial_free_messages) :
        event_client_ct(), M_server_connection(server_connection),
        M_messages_per_second(messages_per_second), M_max_free_messages(max_free_messages),
        M_free_messages(initial_free_messages), M_time(timer_event_server_ct::instance().get_now()) { }
    ~Queue() { cancel_all_requests(); }

  private:
    //! Flush output messages if possible.
    void flush(void);
    void send_next_message(timer_event_type_ct const&);

  public:
    //! Send or queue an output message.
    void queue_msg(MessageOut const& message_out) { M_priority_queue.push(message_out); this->flush(); }
};

#endif // QUEUE_H

---