/home/jander/temp/etherdune/SharedBuffer.h

Go to the documentation of this file.

// EtherDune Shared circular buffer class
// Author: Javier Peletier <jm@friendev.com>
// Summary: Implements a "shared" circular buffer using spare ENC28J60 memory
//
// Copyright (c) 2015 All Rights Reserved, http://friendev.com
//
// This source is subject to the GPLv2 license.
// Please see the License.txt file for more information.
// All other rights reserved.
//
// THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY 
// KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
// PARTICULAR PURPOSE.

#ifndef SHARED_BUFFER_H
#define SHARED_BUFFER_H

#include "List.h"

class SharedBuffer : ListItem
{
    
    static uint16_t head;
    static uint16_t usedSpace;
    static List bufferList;

    uint16_t nextRead;
    uint16_t lastWritten;
    
    static uint16_t append(uint16_t len, const byte* data);
    static uint16_t writeAt(uint16_t index, uint16_t len, const byte* data);
    static uint16_t readAt(uint16_t index, uint16_t len, byte* data );


public:

    uint16_t write(uint16_t len, const byte* data);
    uint16_t release();

    SharedBuffer();
    ~SharedBuffer();

    void flush();
    bool isEmpty();
    uint16_t fillTxBuffer(uint16_t dstOffset, uint16_t& checksum, uint16_t count=0xFFFF);



};







#endif