diff packages/kernel/current/include/mboxt.hxx @ 0:3111d98ba7b3 ecos-v1_1-release

Initial commit of eCos version 1.1
author jlarmour
date Tue, 11 May 1999 11:16:07 +0000
parents
children 443894e2e912
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/packages/kernel/current/include/mboxt.hxx
@@ -0,0 +1,127 @@
+#ifndef CYGONCE_KERNEL_MBOXT_HXX
+#define CYGONCE_KERNEL_MBOXT_HXX
+
+//==========================================================================
+//
+//	mboxt.hxx
+//
+//	Mboxt (Message Box/Mailbox) class declarations
+//
+//==========================================================================
+//####COPYRIGHTBEGIN####
+//
+// -------------------------------------------
+// The contents of this file are subject to the Cygnus eCos Public License
+// Version 1.0 (the "License"); you may not use this file except in
+// compliance with the License.  You may obtain a copy of the License at
+// http://sourceware.cygnus.com/ecos
+// 
+// Software distributed under the License is distributed on an "AS IS"
+// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.  See the
+// License for the specific language governing rights and limitations under
+// the License.
+// 
+// The Original Code is eCos - Embedded Cygnus Operating System, released
+// September 30, 1998.
+// 
+// The Initial Developer of the Original Code is Cygnus.  Portions created
+// by Cygnus are Copyright (C) 1998 Cygnus Solutions.  All Rights Reserved.
+// -------------------------------------------
+//
+//####COPYRIGHTEND####
+//==========================================================================
+//#####DESCRIPTIONBEGIN####
+//
+// Author(s): 	hmt
+// Contributors:	hmt
+// Date:	1998-02-10
+// Purpose:	Define Mboxt class interfaces
+// Description:	The classes defined here provide the APIs for mboxtes.
+// Usage:	#include <cyg/kernel/mboxt.hxx>
+//		#include <cyg/kernel/mboxt.inl>
+//		
+//
+//####DESCRIPTIONEND####
+//
+//==========================================================================
+
+#include <cyg/kernel/ktypes.h>
+#include <cyg/infra/cyg_ass.h>            // assertion macros
+#include <cyg/kernel/thread.hxx>
+
+// -------------------------------------------------------------------------
+// Message/Mail Box.  This template implements a queue of T's.
+// Implemented as a template for maximal flexibility; one would hope
+// that only one, with T==(void *) and the same number of them,
+// is ever used without very good reason.
+
+// Cyg_Mboxt has a fixed size array of T's; one size fits all.
+
+template <class T, cyg_count32 QUEUE_SIZE>
+class Cyg_Mboxt
+{
+private:
+    cyg_count32         base;           // index of first used slot
+    cyg_count32         count;          // count of used slots
+    Cyg_ThreadQueue     get_threadq;    // Queue of waiting threads
+#ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
+    Cyg_ThreadQueue     put_threadq;    // Queue of waiting threads
+#endif
+    static const
+    cyg_count32		size = QUEUE_SIZE;
+    T			itemqueue[ QUEUE_SIZE ];
+                                        // queue of items
+    // private utility functions
+    // wake up a thread from some queue
+    inline void 	wakeup_waiter( Cyg_ThreadQueue &q );
+
+public:
+
+    CYGDBG_DEFINE_CHECK_THIS
+    
+    Cyg_Mboxt();                        // Constructor
+    ~Cyg_Mboxt();                       // Destructor
+        
+    cyg_bool	get( T &ritem );        // get an item; wait if none
+#ifdef CYGFUN_KERNEL_THREADS_TIMER
+    cyg_bool	get( T &ritem, cyg_tick_count abs_timeout );
+#endif
+    cyg_bool	tryget( T &ritem );     // just one attempt
+
+    cyg_bool	peek_item( T &ritem );  // get next item without
+                                        // removing it
+
+#ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
+    cyg_bool	put( const T item );    // put an item; wait if full
+#ifdef CYGFUN_KERNEL_THREADS_TIMER
+    cyg_bool	put( const T item, cyg_tick_count abs_timeout );
+#endif
+#endif
+    cyg_bool	tryput( const T item ); // fails if Q full
+
+    inline
+    cyg_count32 peek()                  // Get current count value
+    {
+        return count;
+    }
+
+    inline
+    cyg_bool	waiting_to_get()        // Any threads waiting?
+    {
+        return ! get_threadq.empty();
+    }
+
+    inline
+    cyg_bool	waiting_to_put()        // Any threads waiting?
+    {
+#ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
+        return ! put_threadq.empty();
+#else
+        return false;
+#endif
+    }
+};
+
+// -------------------------------------------------------------------------
+#endif // ifndef CYGONCE_KERNEL_MBOXT_HXX
+// EOF mboxt.hxx