line-request.hpp

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/* SPDX-FileCopyrightText: 2021-2022 Bartosz Golaszewski <brgl@bgdev.pl> */
 
#ifndef __LIBGPIOD_CXX_LINE_REQUEST_HPP__
#define __LIBGPIOD_CXX_LINE_REQUEST_HPP__
 
#if !defined(__LIBGPIOD_GPIOD_CXX_INSIDE__)
#error "Only gpiod.hpp can be included directly."
#endif
 
#include <chrono>
#include <cstddef>
#include <iostream>
#include <memory>
 
#include "misc.hpp"
 
namespace gpiod {
 
class chip;
class edge_event;
class edge_event_buffer;
class line_config;
 
class line_request final
{
public:
 
    line_request(const line_request& other) = delete;
 
    line_request(line_request&& other) noexcept;
 
    ~line_request();
 
    line_request& operator=(const line_request& other) = delete;
 
    line_request& operator=(line_request&& other) noexcept;
 
    explicit operator bool() const noexcept;
 
    void release();
 
    ::std::string chip_name() const;
 
    ::std::size_t num_lines() const;
 
    line::offsets offsets() const;
 
    line::value get_value(line::offset offset);
 
    line::values get_values(const line::offsets& offsets);
 
    line::values get_values();
 
    void get_values(const line::offsets& offsets, line::values& values);
 
    void get_values(line::values& values);
 
    line_request& set_value(line::offset offset, line::value value);
 
    line_request& set_values(const line::value_mappings& values);
 
    line_request& set_values(const line::offsets& offsets, const line::values& values);
 
    line_request& set_values(const line::values& values);
 
    line_request& reconfigure_lines(const line_config& config);
 
    int fd() const;
 
    bool wait_edge_events(const ::std::chrono::nanoseconds& timeout) const;
 
    ::std::size_t read_edge_events(edge_event_buffer& buffer);
 
    ::std::size_t read_edge_events(edge_event_buffer& buffer, ::std::size_t max_events);
 
private:
 
    line_request();
 
    struct impl;
 
    ::std::unique_ptr<impl> _m_priv;
 
    friend request_builder;
};
 
::std::ostream& operator<<(::std::ostream& out, const line_request& request);
 
} /* namespace gpiod */
 
#endif /* __LIBGPIOD_CXX_LINE_REQUEST_HPP__ */