ecos-v2_0-branch: packages/kernel/current/include/mboxt.hxx annotate

annotate packages/kernel/current/include/mboxt.hxx @ 823:19a153ac403c default tip

* Added execute permissions to files missed in conversion from CVS

author	alexs
date	Thu, 08 May 2003 17:42:17 +0000
parents	d2c90368aeef
children

rev	line source
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	1 #ifndef CYGONCE_KERNEL_MBOXT_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	2 #define CYGONCE_KERNEL_MBOXT_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	3
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	4 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	5 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	6 // mboxt.hxx
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	7 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	8 // Mboxt (Message Box/Mailbox) class declarations
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	9 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	10 //==========================================================================
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	11 //####ECOSGPLCOPYRIGHTBEGIN####
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	12 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	13 // This file is part of eCos, the Embedded Configurable Operating System.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	14 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	15 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	16 // eCos is free software; you can redistribute it and/or modify it under
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	17 // the terms of the GNU General Public License as published by the Free
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	18 // Software Foundation; either version 2 or (at your option) any later version.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	19 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	20 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	21 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	22 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	23 // for more details.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	24 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	25 // You should have received a copy of the GNU General Public License along
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	26 // with eCos; if not, write to the Free Software Foundation, Inc.,
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	27 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	28 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	29 // As a special exception, if other files instantiate templates or use macros
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	30 // or inline functions from this file, or you compile this file and link it
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	31 // with other works to produce a work based on this file, this file does not
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	32 // by itself cause the resulting work to be covered by the GNU General Public
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	33 // License. However the source code for this file must still be made available
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	34 // in accordance with section (3) of the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	35 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	36 // This exception does not invalidate any other reasons why a work based on
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	37 // this file might be covered by the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	38 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	39 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
210 d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST jlarmour parents: 208 diff changeset	40 // at http://sources.redhat.com/ecos/ecos-license/
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	41 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	42 //####ECOSGPLCOPYRIGHTEND####
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	43 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	44 //#####DESCRIPTIONBEGIN####
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	45 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	46 // Author(s): hmt
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	47 // Contributors: hmt
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	48 // Date: 1998-02-10
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	49 // Purpose: Define Mboxt class interfaces
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	50 // Description: The classes defined here provide the APIs for mboxtes.
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	51 // Usage: #include <cyg/kernel/mboxt.hxx>
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	52 // #include <cyg/kernel/mboxt.inl>
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	53 //
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	54 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	55 //####DESCRIPTIONEND####
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	56 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	57 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	58
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	59 #include <cyg/kernel/ktypes.h>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	60 #include <cyg/infra/cyg_ass.h> // assertion macros
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	61 #include <cyg/kernel/thread.hxx>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	62
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	63 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	64 // Message/Mail Box. This template implements a queue of T's.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	65 // Implemented as a template for maximal flexibility; one would hope
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	66 // that only one, with T==(void *) and the same number of them,
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	67 // is ever used without very good reason.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	68
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	69 // Cyg_Mboxt has a fixed size array of T's; one size fits all.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	70
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	71 template <class T, cyg_count32 QUEUE_SIZE>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	72 class Cyg_Mboxt
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	73 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	74 private:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	75 cyg_count32 base; // index of first used slot
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	76 cyg_count32 count; // count of used slots
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	77 Cyg_ThreadQueue get_threadq; // Queue of waiting threads
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	78 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	79 Cyg_ThreadQueue put_threadq; // Queue of waiting threads
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	80 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	81 static const
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	82 cyg_count32 size = QUEUE_SIZE;
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	83 T itemqueue[ QUEUE_SIZE ];
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	84 // queue of items
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	85 // private utility functions
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	86 // wake up a thread from some queue
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	87 inline void wakeup_waiter( Cyg_ThreadQueue &q );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	88
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	89 public:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	90
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	91 CYGDBG_DEFINE_CHECK_THIS
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	92
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	93 Cyg_Mboxt(); // Constructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	94 ~Cyg_Mboxt(); // Destructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	95
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	96 cyg_bool get( T &ritem ); // get an item; wait if none
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	97 #ifdef CYGFUN_KERNEL_THREADS_TIMER
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	98 cyg_bool get( T &ritem, cyg_tick_count abs_timeout );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	99 #endif
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	100 cyg_bool tryget( T &ritem ); // just one attempt
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	101
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	102 cyg_bool peek_item( T &ritem ); // get next item without
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	103 // removing it
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	104
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	105 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	106 cyg_bool put( const T item ); // put an item; wait if full
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	107 #ifdef CYGFUN_KERNEL_THREADS_TIMER
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	108 cyg_bool put( const T item, cyg_tick_count abs_timeout );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	109 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	110 #endif
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	111 cyg_bool tryput( const T item ); // fails if Q full
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	112
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	113 inline
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	114 cyg_count32 peek() // Get current count value
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	115 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	116 return count;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	117 }
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	118
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	119 inline
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	120 cyg_bool waiting_to_get() // Any threads waiting?
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	121 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	122 return ! get_threadq.empty();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	123 }
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	124
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	125 inline
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	126 cyg_bool waiting_to_put() // Any threads waiting?
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	127 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	128 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	129 return ! put_threadq.empty();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	130 #else
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	131 return false;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	132 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	133 }
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	134 };
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	135
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	136 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	137 #endif // ifndef CYGONCE_KERNEL_MBOXT_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	138 // EOF mboxt.hxx

Mercurial > ecos-v2_0-branch

annotate packages/kernel/current/include/mboxt.hxx @ 823:19a153ac403c default tip