| 115 |
ira |
1 |
/* Copyright (c) 2005, Ira W. Snyder (devel@irasnyder.com)
|
|
|
2 |
* All rights reserved.
|
|
|
3 |
*
|
|
|
4 |
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
5 |
* of this software and associated documentation files (the "Software"), to
|
|
|
6 |
* deal in the Software without restriction, including without limitation the
|
|
|
7 |
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
|
8 |
* sell copies of the Software, and to permit persons to whom the Software is
|
|
|
9 |
* furnished to do so, subject to the following conditions:
|
|
|
10 |
*
|
|
|
11 |
* The above copyright notice and this permission notice shall be included in
|
|
|
12 |
* all copies or substantial portions of the Software.
|
|
|
13 |
*
|
|
|
14 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
15 |
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
16 |
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
17 |
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
18 |
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
|
19 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
|
20 |
* IN THE SOFTWARE.
|
|
|
21 |
*/
|
|
|
22 |
|
|
|
23 |
|
|
|
24 |
#ifndef _RING_BUFFER_H_
|
|
|
25 |
#define _RING_BUFFER_H_
|
|
|
26 |
|
|
|
27 |
#include <memory.h>
|
|
|
28 |
#include <assert.h>
|
|
|
29 |
#include <stdint.h>
|
|
|
30 |
|
|
|
31 |
class RingBuffer
|
|
|
32 |
{
|
|
|
33 |
|
|
|
34 |
/* =============================================================================
|
|
|
35 |
PRIVATE VARIABLES
|
|
|
36 |
===========================================================================*/
|
|
|
37 |
private:
|
|
|
38 |
|
|
|
39 |
int32_t buffer_size; //Size of the buffer
|
|
|
40 |
int8_t *buffer; //The buffer itself
|
|
|
41 |
|
|
|
42 |
int8_t *r_ptr; //The read pointer
|
|
|
43 |
int8_t *w_ptr; //The write pointer
|
|
|
44 |
|
|
|
45 |
int8_t *buffer_begin; //Pointer to the first byte in the buffer
|
|
|
46 |
int8_t *buffer_end; //Pointer to the last byte in the buffer
|
|
|
47 |
|
|
|
48 |
int32_t available_bytes;//The number of bytes currently stored
|
|
|
49 |
|
|
|
50 |
/* =============================================================================
|
|
|
51 |
PRIVATE FUNCTIONS
|
|
|
52 |
===========================================================================*/
|
|
|
53 |
private:
|
|
|
54 |
|
|
|
55 |
/* =============================================================================
|
|
|
56 |
PUBLIC FUNCTIONS
|
|
|
57 |
===========================================================================*/
|
|
|
58 |
public:
|
|
|
59 |
|
|
|
60 |
RingBuffer (int32_t buffer_size); //Constructor
|
|
|
61 |
~RingBuffer(); //Destructor
|
|
|
62 |
|
|
|
63 |
int32_t read (int8_t *dst, int32_t bytes); //Read from the buffer
|
|
|
64 |
bool write (int8_t *src, int32_t bytes); //Write to the buffer
|
|
|
65 |
|
|
|
66 |
int32_t numBytes (); //Bytes available
|
|
|
67 |
|
|
|
68 |
};
|
|
|
69 |
#endif
|