gpiod::info_event Class Reference

Immutable object containing data about a single line info event. More...

#include <info-event.hpp>

Public Types
enum	event_type { event_type::LINE_REQUESTED = 1, event_type::LINE_RELEASED, event_type::LINE_CONFIG_CHANGED }
	Types of info events. More...

Public Member Functions
	info_event (const info_event &other)
	Copy constructor. More...
	info_event (info_event &&other) noexcept
	Move constructor. More...
	~info_event ()
info_event &	operator= (const info_event &other)
	Copy assignment operator. More...
info_event &	operator= (info_event &&other) noexcept
	Move assignment operator. More...
event_type	type () const
	Type of this event. More...
::std::uint64_t	timestamp_ns () const noexcept
	Timestamp of the event as returned by the kernel. More...
const line_info &	get_line_info () const noexcept
	Get the new line information. More...

Detailed Description

Immutable object containing data about a single line info event.

Member Enumeration Documentation

enum gpiod::info_event::event_type

strong

Types of info events.

Enumerator
LINE_REQUESTED	Line has been requested.
LINE_RELEASED	Previously requested line has been released.
LINE_CONFIG_CHANGED	Line configuration has changed.

Constructor & Destructor Documentation

gpiod::info_event::info_event

(

const info_event &

other

)

Copy constructor.

Parameters

other

Object to copy.

gpiod::info_event::info_event ( info_event &&  other )

noexcept

Move constructor.

Parameters

other

Object to move.

gpiod::info_event::~info_event

(

)

Member Function Documentation

const line_info& gpiod::info_event::get_line_info ( ) const

noexcept

Get the new line information.

Returns

Constant reference to the line info object containing the line data as read at the time of the info event.

info_event& gpiod::info_event::operator=

(

const info_event &

other

)

Copy assignment operator.

Parameters

other

Object to copy.

Returns

Reference to self.

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

noexcept

Move assignment operator.

Parameters

other

Object to move.

Returns

Reference to self.

::std::uint64_t gpiod::info_event::timestamp_ns ( ) const

noexcept

Timestamp of the event as returned by the kernel.

Returns

Timestamp as a 64-bit unsigned integer.

event_type gpiod::info_event::type

(

)

const

Type of this event.

Returns

Event type.

---

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

• /tmp/B.plsheoz0/BUILD/libgpiod-2.2.3-build/libgpiod-2.2.3/bindings/cxx/gpiodcxx/info-event.hpp