Support for conversion from Instruction API objects to Rose SgAsmInstruction objects...
[dyninst.git] / proccontrol / h / Mailbox.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30 #if !defined(MAILBOX_H_)
31 #define MAILBOX_H_
32
33 #include "Event.h"
34 #include "util.h"
35
36 namespace Dyninst {
37 namespace ProcControlAPI {
38
39 class PC_EXPORT Mailbox
40 {
41 public:
42         typedef enum {
43                 low,
44                 med,
45                 high} priority_t;
46
47         Mailbox();
48    virtual ~Mailbox();
49
50    virtual void enqueue(Event::ptr ev, bool priority = false) = 0;
51    virtual void enqueue_user(Event::ptr ev) = 0;
52    virtual bool hasPriorityEvent() = 0;
53    virtual Event::ptr dequeue(bool block) = 0;
54    virtual Event::ptr peek() = 0;
55    virtual unsigned int size() = 0;
56         // These should *only* be used internally to proccontrol...
57    virtual void lock_queue() = 0;
58    virtual void unlock_queue() = 0;
59 };
60
61 extern PC_EXPORT Mailbox* mbox();
62
63 }
64 }
65
66 #endif