zpp::poll_signal Class Reference

class owning a k_poll_signal More...

#include <poll_signal.hpp>

Inheritance diagram for zpp::poll_signal:

Collaboration diagram for zpp::poll_signal:

Public Member Functions
	poll_signal () noexcept
	default constructor initializing the signal More...
auto	native_handle () noexcept -> native_pointer
	get the native k_poll_signal handle More...
auto	native_handle () const noexcept -> native_const_pointer
	get the native k_poll_signal handle More...
	poll_signal (const poll_signal &)=delete
	poll_signal (poll_signal &&)=delete
poll_signal &	operator= (const poll_signal &)=delete
poll_signal &	operator= (poll_signal &&)=delete
Public Member Functions inherited from zpp::poll_signal_base< poll_signal >
	poll_signal_base (const poll_signal_base &)=delete
	poll_signal_base (poll_signal_base &&)=delete
std::optional< int >	check () noexcept
	check if the signal was signaled More...
bool	raise (int result) noexcept
	signal the signal More...
void	reset () noexcept
	reset the state to non-signalled More...
auto	native_handle () noexcept -> native_pointer
	get the native k_poll_signal handle More...
auto	native_handle () const noexcept -> native_const_pointer
	get the native k_poll_signal handle More...
poll_signal_base &	operator= (const poll_signal_base &)=delete
poll_signal_base &	operator= (poll_signal_base &&)=delete

Additional Inherited Members
Public Types inherited from zpp::poll_signal_base< poll_signal >
using	native_type = struct k_poll_signal
using	native_pointer = native_type *
using	native_const_pointer = native_type const *
Protected Member Functions inherited from zpp::poll_signal_base< poll_signal >
	poll_signal_base () noexcept
	default contructor only to be used by derived classes More...

Detailed Description

class owning a k_poll_signal

Definition at line 112 of file poll_signal.hpp.

Constructor & Destructor Documentation

poll_signal() [1/3]

zpp::poll_signal::poll_signal ( )

inlinenoexcept

default constructor initializing the signal

Definition at line 119 of file poll_signal.hpp.

  {
    k_poll_signal_init(&m_signal);
  }

poll_signal() [2/3]

zpp::poll_signal::poll_signal ( const poll_signal &  )

delete

poll_signal() [3/3]

zpp::poll_signal::poll_signal ( poll_signal &&  )

delete

Member Function Documentation

native_handle() [1/2]

auto zpp::poll_signal::native_handle ( ) const -> native_const_pointer

inlinenoexcept

get the native k_poll_signal handle

Returns

pointer to a k_poll_signal

Definition at line 139 of file poll_signal.hpp.

  {
    return &m_signal;
  }

native_handle() [2/2]

auto zpp::poll_signal::native_handle ( ) -> native_pointer

inlinenoexcept

get the native k_poll_signal handle

Returns

pointer to a k_poll_signal

Definition at line 129 of file poll_signal.hpp.

  {
    return &m_signal;
  }

operator=() [1/2]

poll_signal& zpp::poll_signal::operator= ( const poll_signal &  )

delete

operator=() [2/2]

poll_signal& zpp::poll_signal::operator= ( poll_signal &&  )

delete

---

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

• include/zpp/poll_signal.hpp