SharedBuffer.hpp

Go to the documentation of this file.

#pragma once
#include <Pothos/Config.hpp>
#include <memory> //shared_ptr

namespace Pothos {

class POTHOS_API SharedBuffer
{
public:

    static const SharedBuffer &null(void);

    SharedBuffer(void);

    static SharedBuffer make(const size_t numBytes, const long nodeAffinity = -1);

    static SharedBuffer makeCirc(const size_t numBytes, const long nodeAffinity = -1);

    SharedBuffer(const size_t address, const size_t length, std::shared_ptr<void> container);

    SharedBuffer(const size_t address, const size_t length, const SharedBuffer &buffer);

    size_t getAddress(void) const;

    size_t getLength(void) const;

    size_t getAlias(void) const;

    size_t getEnd(void) const;

    bool unique(void) const;

    size_t useCount(void) const;

    explicit operator bool(void) const;

    const std::shared_ptr<void> &getContainer(void) const;

private:
    static SharedBuffer makeCircUnprotected(const size_t numBytes, const long nodeAffinity);
    size_t _address;
    size_t _length;
    size_t _alias;
    std::shared_ptr<void> _container;
};

inline bool operator==(const SharedBuffer &lhs, const SharedBuffer &rhs);

} //namespace Pothos

inline size_t Pothos::SharedBuffer::getAddress(void) const
{
    return _address;
}

inline size_t Pothos::SharedBuffer::getLength(void) const
{
    return _length;
}

inline size_t Pothos::SharedBuffer::getAlias(void) const
{
    return _alias;
}

inline size_t Pothos::SharedBuffer::getEnd(void) const
{
    return _address + _length;
}

inline bool Pothos::SharedBuffer::unique(void) const
{
    return _container.unique();
}

inline size_t Pothos::SharedBuffer::useCount(void) const
{
    return _container.use_count();
}

inline Pothos::SharedBuffer::operator bool(void) const
{
    return bool(_container);
}

inline const std::shared_ptr<void> &Pothos::SharedBuffer::getContainer(void) const
{
    return _container;
}

inline bool Pothos::operator==(const SharedBuffer &lhs, const SharedBuffer &rhs)
{
    return lhs.getContainer() == rhs.getContainer();
}