Consumer.hh revision 6154 
1
2/*
3 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/*
31 * $Id$
32 *
33 * Description: This is the virtual base class of all classes that can
34 * be the targets of wakeup events.  There is only two methods,
35 * wakeup() and print() and no data members.
36 *
37 */
38
39#ifndef CONSUMER_H
40#define CONSUMER_H
41
42#include "mem/ruby/common/Global.hh"
43#include "mem/ruby/eventqueue/RubyEventQueue.hh"
44
45class MessageBuffer;
46
47class Consumer {
48public:
49  // Constructors
50  Consumer() { m_last_scheduled_wakeup = 0; m_last_wakeup = 0; m_out_link_vec.setSize(0); }
51
52  // Destructor
53  virtual ~Consumer() { }
54
55  // Public Methods - pure virtual methods
56  void triggerWakeup() { Time time = g_eventQueue_ptr->getTime(); if (m_last_wakeup != time) { wakeup(); m_last_wakeup = time; }}
57  virtual void wakeup() = 0;
58  virtual void print(ostream& out) const = 0;
59  const Time& getLastScheduledWakeup() const { return m_last_scheduled_wakeup; }
60  void setLastScheduledWakeup(const Time& time) { m_last_scheduled_wakeup = time; }
61  Vector< Vector<MessageBuffer*> > getOutBuffers() { return m_out_link_vec; }
62
63protected:
64  Vector< Vector<MessageBuffer*> > m_out_link_vec;
65
66private:
67  // Private Methods
68
69  // Data Members (m_ prefix)
70  Time m_last_scheduled_wakeup;
71  Time m_last_wakeup;
72};
73
74// Output operator declaration
75inline extern
76ostream& operator<<(ostream& out, const Consumer& obj);
77
78// ******************* Definitions *******************
79
80// Output operator definition
81inline extern
82ostream& operator<<(ostream& out, const Consumer& obj)
83{
84  obj.print(out);
85  out << flush;
86  return out;
87}
88
89#endif //CONSUMER_H
90