Consumer.hh revision 7002
112841Sgabeblack@google.com 212841Sgabeblack@google.com/* 312841Sgabeblack@google.com * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 412841Sgabeblack@google.com * All rights reserved. 512841Sgabeblack@google.com * 612841Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 712841Sgabeblack@google.com * modification, are permitted provided that the following conditions are 812841Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 912841Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 1012841Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 1112841Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1212841Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1312841Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1412841Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1512841Sgabeblack@google.com * this software without specific prior written permission. 1612841Sgabeblack@google.com * 1712841Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1812841Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1912841Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2012841Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2112841Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2212841Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2312841Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2412841Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2512841Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2612841Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2712841Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2812841Sgabeblack@google.com */ 2912841Sgabeblack@google.com 3012841Sgabeblack@google.com/* 3112841Sgabeblack@google.com * $Id$ 3212841Sgabeblack@google.com * 3312841Sgabeblack@google.com * Description: This is the virtual base class of all classes that can 3412841Sgabeblack@google.com * be the targets of wakeup events. There is only two methods, 3512841Sgabeblack@google.com * wakeup() and print() and no data members. 3612841Sgabeblack@google.com * 3712841Sgabeblack@google.com */ 3812841Sgabeblack@google.com 3912841Sgabeblack@google.com#ifndef CONSUMER_H 4012867Sgabeblack@google.com#define CONSUMER_H 4112867Sgabeblack@google.com 4212867Sgabeblack@google.com#include <iostream> 4312841Sgabeblack@google.com 4412841Sgabeblack@google.com#include "mem/ruby/common/Global.hh" 4512841Sgabeblack@google.com#include "mem/ruby/eventqueue/RubyEventQueue.hh" 4612841Sgabeblack@google.com 4712841Sgabeblack@google.comclass MessageBuffer; 4812841Sgabeblack@google.com 4912841Sgabeblack@google.comclass Consumer { 5012841Sgabeblack@google.compublic: 5112841Sgabeblack@google.com // Constructors 5212841Sgabeblack@google.com Consumer() { m_last_scheduled_wakeup = 0; m_last_wakeup = 0; } 5312841Sgabeblack@google.com 5412841Sgabeblack@google.com // Destructor 5512841Sgabeblack@google.com virtual ~Consumer() { } 5612841Sgabeblack@google.com 5712841Sgabeblack@google.com // Public Methods - pure virtual methods 5812841Sgabeblack@google.com // void triggerWakeup() { Time time = g_eventQueue_ptr->getTime(); if (m_last_wakeup != time) { wakeup(); m_last_wakeup = time; }} 5912841Sgabeblack@google.com void triggerWakeup(RubyEventQueue * eventQueue) { Time time = eventQueue->getTime(); if (m_last_wakeup != time) { wakeup(); m_last_wakeup = time; }} 6012841Sgabeblack@google.com virtual void wakeup() = 0; 6112841Sgabeblack@google.com virtual void print(std::ostream& out) const = 0; 6212841Sgabeblack@google.com const Time& getLastScheduledWakeup() const { return m_last_scheduled_wakeup; } 6312841Sgabeblack@google.com void setLastScheduledWakeup(const Time& time) { m_last_scheduled_wakeup = time; } 6412841Sgabeblack@google.com 6512841Sgabeblack@google.comprivate: 6612841Sgabeblack@google.com // Private Methods 6712841Sgabeblack@google.com 6812841Sgabeblack@google.com // Data Members (m_ prefix) 6912841Sgabeblack@google.com Time m_last_scheduled_wakeup; 7012841Sgabeblack@google.com Time m_last_wakeup; 7112841Sgabeblack@google.com}; 7212841Sgabeblack@google.com 7312841Sgabeblack@google.com// Output operator declaration 7412841Sgabeblack@google.cominline extern 7512841Sgabeblack@google.comstd::ostream& operator<<(std::ostream& out, const Consumer& obj); 7612841Sgabeblack@google.com 7712841Sgabeblack@google.com// ******************* Definitions ******************* 7812841Sgabeblack@google.com 7912841Sgabeblack@google.com// Output operator definition 8012841Sgabeblack@google.cominline extern 8112841Sgabeblack@google.comstd::ostream& operator<<(std::ostream& out, const Consumer& obj) 8212841Sgabeblack@google.com{ 8312841Sgabeblack@google.com obj.print(out); 8412841Sgabeblack@google.com out << std::flush; 8512841Sgabeblack@google.com return out; 8612841Sgabeblack@google.com} 8712841Sgabeblack@google.com 8812841Sgabeblack@google.com#endif //CONSUMER_H 8912841Sgabeblack@google.com