IOQueue.h

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * IOQueue.h
 * A non-contigous memory buffer that operates as a queue (FIFO).
 * Copyright (C) 2012 Simon Newton
 */

#ifndef INCLUDE_OLA_IO_IOQUEUE_H_
#define INCLUDE_OLA_IO_IOQUEUE_H_

#include <ola/io/IOVecInterface.h>
#include <ola/io/InputBuffer.h>
#include <ola/io/OutputBuffer.h>
#include <stdint.h>
#include <deque>
#include <iostream>
#include <queue>
#include <string>

namespace ola {
namespace io {

class IOQueue: public InputBufferInterface,
               public OutputBufferInterface,
               public IOVecInterface {
 public:
    IOQueue();
    explicit IOQueue(class MemoryBlockPool *block_pool);

    ~IOQueue();

    unsigned int Size() const;

    bool Empty() const {
      return m_blocks.empty();
    }

    // From OutputBuffer
    void Write(const uint8_t *data, unsigned int length);

    // From InputBuffer, these reads consume data from the buffer.
    unsigned int Read(uint8_t *data, unsigned int length);
    unsigned int Read(std::string *output, unsigned int length);

    unsigned int Peek(uint8_t *data, unsigned int length) const;

    // From IOVecInterface
    const struct IOVec *AsIOVec(int *io_count) const;
    void Pop(unsigned int n);

    // Append a MemoryBlock to this IOQueue. Ownership of the block is taken.
    void AppendBlock(class MemoryBlock *block);

    void Clear();

    // purge the underlying memory pool
    void Purge();

    void Dump(std::ostream *output);

 private:
    typedef std::deque<class MemoryBlock*> BlockVector;

    class MemoryBlockPool* m_pool;
    bool m_delete_pool;

    BlockVector m_blocks;

    void AppendBlock();

    // no copying / assignment for now
    IOQueue(const IOQueue&);
    IOQueue& operator=(const IOQueue&);
};
}  // namespace io
}  // namespace ola
#endif  // INCLUDE_OLA_IO_IOQUEUE_H_