streamer.h

Go to the documentation of this file.

/*===========================================================================
     _____        _____        _____        _____
 ___|    _|__  __|_    |__  __|__   |__  __| __  |__  ______
|    \  /  | ||    \      ||     |     ||  |/ /     ||___   |
|     \/   | ||     \     ||     \     ||     \     ||___   |
|__/\__/|__|_||__|\__\  __||__|\__\  __||__|\__\  __||______|
    |_____|      |_____|      |_____|      |_____|

--[Mark3 Realtime Platform]--------------------------------------------------

Copyright (c) 2012 - 2019 m0slevin, all rights reserved.
See license.txt for more information
=========================================================================== */
#include "kerneltypes.h"
#include "mark3.h"

#pragma once

namespace Mark3
{
//---------------------------------------------------------------------------
class Streamer
{
public:
    void Init(uint8_t* pau8Buffer_, uint16_t u16Size_);

    bool Read(uint8_t* pu8Data_);

    uint16_t Read(uint8_t* pu8Data_, uint16_t u16Len_);

    bool Write(uint8_t u8Data_);

    uint16_t Write(const uint8_t* pu8Data_, uint16_t u16Len_);

    bool Claim(uint8_t** pu8Addr_);

    void Lock(uint8_t* pu8LockAddr_);

    void Unlock(void);

    uint16_t GetAvailable(void) { return m_u16Size; }
    bool CanRead(void);

    bool CanWrite(void);

    bool IsEmpty(void);

private:
    uint8_t* m_pau8Buffer;  
    uint8_t* m_pu8LockAddr; 

    uint16_t m_u16Size;  
    uint16_t m_u16Avail; 
    uint16_t m_u16Head;  
    uint16_t m_u16Tail;  
};
} // namespace Mark3