gpiod::request_builder Class Reference

Intermediate object storing the configuration for a line request. More...

#include <request-builder.hpp>

Public Member Functions
	request_builder (const request_builder &other)=delete
	request_builder (request_builder &&other) noexcept
	Move constructor. More...
request_builder &	operator= (const request_builder &other)=delete
request_builder &	operator= (request_builder &&other) noexcept
	Move assignment operator. More...
request_builder &	set_request_config (request_config &req_cfg)
	Set the request config for the request. More...
const request_config &	get_request_config () const noexcept
	Get the current request config. More...
request_builder &	set_consumer (const ::std::string &consumer) noexcept
	Set consumer in the request config stored by this object. More...
request_builder &	set_event_buffer_size (::std::size_t event_buffer_size) noexcept
	Set the event buffer size in the request config stored by this object. More...
request_builder &	set_line_config (line_config &line_cfg)
	Set the line config for this request. More...
const line_config &	get_line_config () const noexcept
	Get the current line config. More...
request_builder &	add_line_settings (line::offset offset, const line_settings &settings)
	Add line settings to the line config stored by this object for a single offset. More...
request_builder &	add_line_settings (const line::offsets &offsets, const line_settings &settings)
	Add line settings to the line config stored by this object for a set of offsets. More...
line_request	do_request ()
	Make the line request. More...

Friends
::std::ostream &	operator<< (::std::ostream &out, const request_builder &builder)
	Stream insertion operator for GPIO request builder objects. More...

Detailed Description

Intermediate object storing the configuration for a line request.

Definition at line 33 of file request-builder.hpp.

Constructor & Destructor Documentation

request_builder()

gpiod::request_builder::request_builder ( request_builder &&  other )

noexcept

Move constructor.

Parameters

other

Object to be moved.

Member Function Documentation

add_line_settings() [1/2]

request_builder& gpiod::request_builder::add_line_settings	(	const line::offsets &	offsets,
		const line_settings &	settings
	)

Add line settings to the line config stored by this object for a set of offsets.

Parameters

offsets	Offsets for which to add settings.
settings	Settings to add.

Returns

Reference to self.

add_line_settings() [2/2]

request_builder& gpiod::request_builder::add_line_settings	(	line::offset	offset,
		const line_settings &	settings
	)

Add line settings to the line config stored by this object for a single offset.

Parameters

offset	Offset for which to add settings.
settings	Line settings to use.

Returns

Reference to self.

do_request()

line_request gpiod::request_builder::do_request

(

)

Make the line request.

Returns

New line_request object.

get_line_config()

const line_config& gpiod::request_builder::get_line_config ( ) const

noexcept

Get the current line config.

Returns

Const reference to the current line config stored by this object.

get_request_config()

const request_config& gpiod::request_builder::get_request_config ( ) const

noexcept

Get the current request config.

Returns

Const reference to the current request config stored by this object.

operator=()

request_builder& gpiod::request_builder::operator= ( request_builder &&  other )

noexcept

Move assignment operator.

Parameters

other

Object to be moved.

Returns

Reference to self.

set_consumer()

request_builder& gpiod::request_builder::set_consumer ( const ::std::string &  consumer )

noexcept

Set consumer in the request config stored by this object.

Parameters

consumer

New consumer string.

Returns

Reference to self.

set_event_buffer_size()

request_builder& gpiod::request_builder::set_event_buffer_size ( ::std::size_t  event_buffer_size )

noexcept

Set the event buffer size in the request config stored by this object.

Parameters

event_buffer_size

New event buffer size.

Returns

Reference to self.

set_line_config()

request_builder& gpiod::request_builder::set_line_config

(

line_config &

line_cfg

)

Set the line config for this request.

Parameters

line_cfg

Line config to use.

Returns

Reference to self.

set_request_config()

request_builder& gpiod::request_builder::set_request_config

(

request_config &

req_cfg

)

Set the request config for the request.

Parameters

req_cfg

Request config to use.

Returns

Reference to self.

Friends And Related Function Documentation

operator<<

::std::ostream& operator<< ( ::std::ostream &  out, const request_builder &  builder  )

friend

Stream insertion operator for GPIO request builder objects.

Parameters

out	Output stream to write to.
builder	Request builder object to insert into the output stream.

Returns

Reference to out.

---

The documentation for this class was generated from the following file:

• request-builder.hpp