Skip to content

File value_fd.h#

File List > include > pisound-micro > value_fd.h

Go to the documentation of this file

// SPDX-License-Identifier: LGPL-2.1-only
//
// libpisoundmicro - a utility library for Pisound Micro I/O expander capabilities.
// Copyright (c) 2017-2025 Vilniaus Blokas UAB, https://blokas.io/
//
// This file is part of libpisoundmicro.
//
// libpisoundmicro 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, version 2.1 of the License.
//
// libpisoundmicro 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 libpisoundmicro. If not, see <https://www.gnu.org/licenses/>.

#ifndef PISOUND_MICRO_VALUE_FD_H
#define PISOUND_MICRO_VALUE_FD_H

#ifndef PISOUND_MICRO_H
#   error Please #include <pisound-micro.h>!
#endif

namespace upisnd
{

class UPISND_API ValueFd
{
public:
    ValueFd();

    explicit ValueFd(int fd); // Takes ownership of the fd.
    ~ValueFd();

    ValueFd(const ValueFd &rhs);

    ValueFd& operator=(const ValueFd &rhs);

    ValueFd(ValueFd &&rhs);

    ValueFd& operator=(ValueFd &&rhs);

    bool isValid() const;

    int take();

    int get() const;

    int close();

    int write(int value);

    int read(int *err = NULL) const;

private:
    int m_fd;
};

} // namespace upisnd

#endif // PISOUND_MICRO_VALUE_FD_H