unified MX27, MX25, MX37 trees
[karo-tx-redboot.git] / packages / kernel / v2_0 / src / sync / mbox.cxx
1 //==========================================================================
2 //
3 //      mbox.cxx
4 //
5 //      Mbox mbox template class implementation
6 //
7 //==========================================================================
8 //####ECOSGPLCOPYRIGHTBEGIN####
9 // -------------------------------------------
10 // This file is part of eCos, the Embedded Configurable Operating System.
11 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
12 //
13 // eCos is free software; you can redistribute it and/or modify it under
14 // the terms of the GNU General Public License as published by the Free
15 // Software Foundation; either version 2 or (at your option) any later version.
16 //
17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
20 // for more details.
21 //
22 // You should have received a copy of the GNU General Public License along
23 // with eCos; if not, write to the Free Software Foundation, Inc.,
24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
25 //
26 // As a special exception, if other files instantiate templates or use macros
27 // or inline functions from this file, or you compile this file and link it
28 // with other works to produce a work based on this file, this file does not
29 // by itself cause the resulting work to be covered by the GNU General Public
30 // License. However the source code for this file must still be made available
31 // in accordance with section (3) of the GNU General Public License.
32 //
33 // This exception does not invalidate any other reasons why a work based on
34 // this file might be covered by the GNU General Public License.
35 //
36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
37 // at http://sources.redhat.com/ecos/ecos-license/
38 // -------------------------------------------
39 //####ECOSGPLCOPYRIGHTEND####
40 //==========================================================================
41 //#####DESCRIPTIONBEGIN####
42 //
43 // Author(s):   hmt
44 // Contributors:        hmt
45 // Date:        1998-02-11
46 // Purpose:     Mbox implementation
47 // Description: This file contains the implementations of the mbox class
48 //
49 //####DESCRIPTIONEND####
50 //
51 //==========================================================================
52
53 #include <pkgconf/kernel.h>
54
55 #include <cyg/kernel/ktypes.h>         // base kernel types
56 #include <cyg/infra/cyg_trac.h>        // tracing macros
57 #include <cyg/infra/cyg_ass.h>         // assertion macros
58 #include <cyg/kernel/instrmnt.h>       // instrumentation
59
60 #include <cyg/kernel/thread.inl>       // Cyg_Thread inlines
61
62 #include <cyg/kernel/mbox.hxx>         // our own header
63
64 #ifndef CYGIMP_MBOXT_INLINE            // force inlining
65 #define CYGIMP_MBOXT_INLINE            // of implementation
66 #endif
67
68 #ifdef CYGIMP_MBOX_USE_MBOXT_PLAIN
69 #include <cyg/kernel/mboxt.inl>        // mbox template implementation
70 #else
71 #include <cyg/kernel/mboxt2.inl>       // mbox template implementation
72 #endif
73
74 // -------------------------------------------------------------------------
75 // This module exists to cause exactly one instance of these functions to
76 // exist; this is just like a vanilla class, except we use the template
77 // class to acquire an implementation.  The template functions are inlined
78 // in each of these methods.
79
80
81 // -------------------------------------------------------------------------
82 // Constructor
83
84 Cyg_Mbox::Cyg_Mbox()
85 {
86 }
87
88 // -------------------------------------------------------------------------
89 // Destructor
90
91 Cyg_Mbox::~Cyg_Mbox()
92 {
93 }
94
95 // -------------------------------------------------------------------------
96 // debugging/assert function
97
98 #ifdef CYGDBG_USE_ASSERTS
99 cyg_bool 
100 Cyg_Mbox::check_this(cyg_assert_class_zeal zeal) const
101 {
102     return m.check_this(zeal);
103 }
104 #endif
105
106 // -------------------------------------------------------------------------
107 // now the members themselves:
108     
109 void *
110 Cyg_Mbox::get()
111 {
112     void * p=NULL;
113     if ( ! m.get( p ) )
114         return NULL;
115     return p;
116 }
117
118 #ifdef CYGFUN_KERNEL_THREADS_TIMER
119 void *
120 Cyg_Mbox::get( cyg_tick_count timeout )
121 {
122     void * p=NULL;
123     if ( ! m.get( p, timeout ) )
124         return NULL;
125     return p;
126 }
127 #endif
128
129 void *
130 Cyg_Mbox::tryget()
131 {
132     void * p=NULL;
133     if ( ! m.tryget( p ) )
134         return NULL;
135     return p;
136 }
137
138 #ifdef  CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
139 cyg_bool
140 Cyg_Mbox::put( void *item )
141 {
142     return m.put( item );
143 }
144
145 #ifdef CYGFUN_KERNEL_THREADS_TIMER
146 cyg_bool
147 Cyg_Mbox::put( void *item, cyg_tick_count timeout )
148 {
149     return m.put( item, timeout );
150 }
151 #endif
152 #endif // CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
153
154 cyg_bool
155 Cyg_Mbox::tryput( void *item )
156 {
157     return m.tryput( item );
158 }
159
160 void *
161 Cyg_Mbox::peek_item()                   // Get next item to be returned
162 {
163     void *p=NULL;
164     if ( ! m.peek_item( p ) )
165         return NULL;
166     return p;
167 }
168
169 // -------------------------------------------------------------------------
170 // EOF mbox.cxx