1 // Copyright (C) 1999-2005 Open Source Telecom Corporation.
2 // Copyright (C) 2006-2010 David Sugar, Tycho Softworks.
3 //
4 // This program is free software; you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation; either version 2 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 //
18 // As a special exception, you may use this file as part of a free software
19 // library without restriction. Specifically, if other files instantiate
20 // templates or use macros or inline functions from this file, or you compile
21 // this file and link it with other files to produce an executable, this
22 // file does not by itself cause the resulting executable to be covered by
23 // the GNU General Public License. This exception does not however
24 // invalidate any other reasons why the executable file might be covered by
25 // the GNU General Public License.
26 //
27 // This exception applies only to the code released under the name GNU
28 // Common C++. If you copy code from other releases into a copy of GNU
29 // Common C++, as the General Public License permits, the exception does
30 // not apply to the code that you add in this way. To avoid misleading
31 // anyone as to the status of such modified files, you must delete
32 // this exception notice from them.
33 //
34 // If you write modifications of your own for GNU Common C++, it is your choice
35 // whether to permit this exception to apply to your modifications.
36 // If you do not wish that, delete this exception notice.
37 //
38
44 #ifndef CCXX_BUFFER_H_
45 #define CCXX_BUFFER_H_
46
47 #ifndef CCXX_THREAD_H_
49 #endif
50 #ifndef CCXX_STRING_H_
52 #endif
53 #ifdef CCXX_NAMESPACES
54 namespace ost {
55 #endif
56
78 #ifdef WIN32
80 #else
82 #endif
83 {
84 private:
85 #ifdef WIN32
87 #endif
90
91 protected:
97 virtual size_t onPeek(void *buf) = 0;
98
104 virtual size_t onWait(void *buf) = 0;
105
111 virtual size_t onPost(void *buf) = 0;
112
113 public:
119
130
136 {return _size;};
137
145 {return _used;};
146
157
166 size_t post(
void *buf,
timeout_t timeout = 0);
167
174 size_t peek(void *buf);
175
180 virtual bool isValid(void);
181 };
182
191 {
192 private:
195
196 protected:
202 size_t onPeek(void *buf);
203
209 size_t onWait(void *buf);
210
216 size_t onPost(void *buf);
217
218 public:
227
235
240
242
243 bool isValid(void);
244 };
245
262 {
263 private:
264 void run(void); // private run method
265
266 protected:
272
275
277
279
280 /*
281 * Overloading of final(). It demarks Semaphore to avoid deadlock.
282 */
283 virtual void final();
284
289 virtual void startQueue(void);
290
296 virtual void stopQueue(void);
297
301 virtual void onTimer(void);
302
311 virtual void runQueue(void *data) = 0;
312
313 public:
321 ThreadQueue(
const char *
id,
int pri,
size_t stack = 0);
322
327
336
345 void post(const void *data, unsigned len);
346 };
347
348
351 {return b.wait(o, t);}
352
355 {
return b.
post(o, t);}
356
360
361
362 #ifdef CCXX_NAMESPACES
363 }
364 #endif
365
366 #endif
367
Common C++ generic string class.
size_t post(void *buf, timeout_t timeout=0)
Post an object into the buffer and enable a waiting thread to receive it.
A semaphore is generally used as a synchronization object between multiple threads or to protect a li...
The Mutex class is used to protect a section of code so that at any given time only a single thread c...
This is a generic and portable string class.
A conditional variable synchcronization object for one to one and one to many signal and control even...
size_t peek(Buffer &b, void *o)
Synchronization and threading services.
The buffer class represents an IPC service that is built upon a buffer of fixed capacity that can be ...
static const size_t timeout
value to return when a timed operation returned with a timeout.
A buffer class that holds a known capacity of fixed sized objects defined during creation.
size_t put(Buffer &b, void *o, timeout_t t=0)
Somewhat generic queue processing class to establish a producer consumer queue.
size_t getSize(void)
Return the capacity of the buffer as specified at creation.
Every thread of execution in an application is created by instantiating an object of a class derived ...
size_t getUsed(void)
Return the current capacity in use for the buffer.
size_t peek(void *buf)
Peek at the current content (first object) in the buffer.