Sam Grove / Buffer

Buffer for general purpose use. Templated for most datatypes

Dependents:   BufferedSoftSerial 09_PT1000 10_PT1000 11_PT1000 ... more

Example

 #include "mbed.h"
 #include "Buffer.h"

 Buffer <char> buf;

 int main()
 {
     buf = 'a';
     buf.put('b');
     char *head = buf.head();
     puts(head);

     char whats_in_there[2] = {0};
     int pos = 0;

     while(buf.available())
     {   
         whats_in_there[pos++] = buf;
     }
     printf("%c %c\n", whats_in_there[0], whats_in_there[1]);
     buf.clear();
     error("done\n\n\n");
 }

Buffer.cpp

Committer:
sam_grove
Date:
2013-05-23
Revision:
2:d13a72146516
Parent:
1:490224f41c09
Child:
4:cd0a1f4c623f

File content as of revision 2:d13a72146516:


/**
 * @file    Buffer.cpp
 * @brief   Software Buffer - Templated Ring Buffer for most data types
 * @author  sam grove
 * @version 1.0
 * @see     
 *
 * Copyright (c) 2013
 *
 * Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#include "Buffer.h"

template <class T>
Buffer<T>::Buffer(BUFFER_SIZE size)
{
    _buf = new T [size];
    _sizemask = size-1;
    clear();
    
    return;
}

template <class T>
Buffer<T>::~Buffer()
{
    delete [] _buf;
    
    return;
}

template <class T>
void Buffer<T>::put(T data)
{
    _buf[_wloc++] = data;
    _wloc &= _sizemask;
    
    return;
}

template <class T>
T Buffer<T>::get(void)
{
    T data_pos = _buf[_rloc++];
    _rloc &= _sizemask;
    
    return data_pos;
}

template <class T>
T *Buffer<T>::head(void)
{
    T *data_pos = &_buf[0];
    
    return data_pos;
}

template <class T>
void Buffer<T>::clear(void)
{
    _wloc = 0;
    _rloc = 0;
    memset(_buf, 0, _sizemask+1);
    
    return;
}

template <class T>
uint32_t Buffer<T>::available(void)
{
    return (_wloc == _rloc) ? 0 : 1;
}

template <class T>
uint32_t Buffer<T>::peek(char c)
{
    return 1;
}



// make the linker aware of some possible types
template class Buffer<uint8_t>;
template class Buffer<int8_t>;
template class Buffer<uint16_t>;
template class Buffer<int16_t>;
template class Buffer<uint32_t>;
template class Buffer<int32_t>;
template class Buffer<uint64_t>;
template class Buffer<int64_t>;
template class Buffer<char>;
template class Buffer<wchar_t>;