zpp::poll_event Class Reference

wrapper class around a k_poll_event More...

#include <poll_event.hpp>

Public Types
enum class	type_tag : uint8_t {   type_unknown , type_sem , type_fifo , type_signal ,   type_ignore }
	type of event sources More...

Public Member Functions
	poll_event (k_poll_event *event) noexcept
	wrap a k_poll_event pointer More...
void	assign (std::nullptr_t) noexcept
	assign a null event (that will be ignored when polling) More...
void	assign (sem &s) noexcept
	assign a semaphore to this event More...
void	assign (sem_ref &s) noexcept
	assign a semaphore to this event More...
template<typename T_FifoItem >
void	assign (fifo< T_FifoItem > &f) noexcept
	assign a fifo to this event More...
template<typename T_FifoItem >
void	assign (fifo_ref< T_FifoItem > &f) noexcept
	assign a fifo to this event More...
void	assign (poll_signal &s) noexcept
	assign a signal to this event More...
void	assign (poll_signal_ref &s) noexcept
	assign a signal to this event More...
bool	is_ready () noexcept
	check if this event is ready More...
void	reset () noexcept
	reset event to non ready state More...
bool	is_cancelled () noexcept
	check if this event is cancelled More...
template<typename T_FifoItemType >
auto	fifo () noexcept
	get access to the fifo of the event More...
auto	sem () noexcept
	get access to the sem of the event More...
auto	signal () noexcept
	get access to the signal of the event More...
	poll_event (const poll_event &)=delete
	poll_event (poll_event &&)=delete
poll_event &	operator= (const poll_event &)=delete
poll_event &	operator= (poll_event &&)=delete

Detailed Description

wrapper class around a k_poll_event

Definition at line 29 of file poll_event.hpp.

Member Enumeration Documentation

type_tag

enum zpp::poll_event::type_tag : uint8_t

strong

type of event sources

Enumerator
type_unknown
type_sem
type_fifo
type_signal
type_ignore

Definition at line 34 of file poll_event.hpp.

                      : uint8_t {
    type_unknown,
    type_sem,
    type_fifo,
    type_signal,
    type_ignore,
  };

Constructor & Destructor Documentation

poll_event() [1/3]

zpp::poll_event::poll_event ( k_poll_event *  event )

inlinenoexcept

wrap a k_poll_event pointer

Parameters

event

the event to wrap

Definition at line 47 of file poll_event.hpp.

    : m_event(event)
  {
    __ASSERT_NO_MSG(m_event != nullptr);
  }

poll_event() [2/3]

zpp::poll_event::poll_event ( const poll_event &  )

delete

poll_event() [3/3]

zpp::poll_event::poll_event ( poll_event &&  )

delete

Member Function Documentation

assign() [1/7]

template<typename T_FifoItem >

void zpp::poll_event::assign ( fifo< T_FifoItem > &  f )

inlinenoexcept

assign a fifo to this event

Parameters

f	the fifo to poll

Definition at line 103 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_FIFO_DATA_AVAILABLE,
      K_POLL_MODE_NOTIFY_ONLY,
      f.native_handle());
    m_event->tag = (int)type_tag::type_fifo;
  }

References type_fifo.

assign() [2/7]

template<typename T_FifoItem >

void zpp::poll_event::assign ( fifo_ref< T_FifoItem > &  f )

inlinenoexcept

assign a fifo to this event

Parameters

f	the fifo to poll

Definition at line 119 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_FIFO_DATA_AVAILABLE,
      K_POLL_MODE_NOTIFY_ONLY,
      f.native_handle());
    m_event->tag = (int)type_tag::type_fifo;
  }

References type_fifo.

assign() [3/7]

void zpp::poll_event::assign ( poll_signal &  s )

inlinenoexcept

assign a signal to this event

Parameters

s	the signal to poll

Definition at line 134 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_SIGNAL,
      K_POLL_MODE_NOTIFY_ONLY,
      s.native_handle());
    m_event->tag = (int)type_tag::type_signal;
  }

References type_signal.

assign() [4/7]

void zpp::poll_event::assign ( poll_signal_ref &  s )

inlinenoexcept

assign a signal to this event

Parameters

s	the signal to poll

Definition at line 149 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_SIGNAL,
      K_POLL_MODE_NOTIFY_ONLY,
      s.native_handle());
    m_event->tag = (int)type_tag::type_signal;
  }

References type_signal.

assign() [5/7]

void zpp::poll_event::assign ( sem &  s )

inlinenoexcept

assign a semaphore to this event

Parameters

s	the semaphore to poll

Definition at line 72 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_SEM_AVAILABLE,
      K_POLL_MODE_NOTIFY_ONLY,
      s.native_handle());
    m_event->tag = (int)type_tag::type_sem;
  }

References type_sem.

assign() [6/7]

void zpp::poll_event::assign ( sem_ref &  s )

inlinenoexcept

assign a semaphore to this event

Parameters

s	the semaphore to poll

Definition at line 87 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_SEM_AVAILABLE,
      K_POLL_MODE_NOTIFY_ONLY,
      s.native_handle());
    m_event->tag = (int)type_tag::type_sem;
  }

References type_sem.

assign() [7/7]

void zpp::poll_event::assign ( std::nullptr_t  )

inlinenoexcept

assign a null event (that will be ignored when polling)

Definition at line 56 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
 
    m_event->obj = nullptr;
    m_event->state = K_POLL_STATE_NOT_READY;
    m_event->mode = K_POLL_MODE_NOTIFY_ONLY;
    m_event->type = K_POLL_TYPE_IGNORE;
    m_event->tag = (int)type_tag::type_ignore;
  }

References type_ignore.

fifo()

template<typename T_FifoItemType >

auto zpp::poll_event::fifo ( )

inlinenoexcept

get access to the fifo of the event

Warning

the event must be an fifo event and the fifo ItemType must match with the registerred ItemType

Returns

a fifo_ref that points to the registered fifo

Definition at line 222 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag == (int)type_tag::type_fifo);
    __ASSERT_NO_MSG(m_event->fifo != nullptr);
 
    return fifo_ref<T_FifoItemType>(m_event->fifo);
  }

References type_fifo.

is_cancelled()

bool zpp::poll_event::is_cancelled ( )

inlinenoexcept

check if this event is cancelled

Returns

true if the event is cancelled

Definition at line 201 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag != (int)type_tag::type_unknown);
 
    if (m_event->state & K_POLL_STATE_CANCELLED) {
      return true;
    } else {
      return false;
    }
  }

References type_unknown.

is_ready()

bool zpp::poll_event::is_ready ( )

inlinenoexcept

check if this event is ready

Returns

true if the event is ready

Definition at line 165 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag != (int)type_tag::type_unknown);
 
    switch((type_tag)m_event->tag) {
    case type_tag::type_unknown:
      return false;
    case type_tag::type_sem:
      return (m_event->state & K_POLL_STATE_SEM_AVAILABLE);
    case type_tag::type_fifo:
      return (m_event->state & K_POLL_STATE_FIFO_DATA_AVAILABLE);
    case type_tag::type_signal:
      return (m_event->state & K_POLL_STATE_SIGNALED);
    case type_tag::type_ignore:
      return false;
    }
 
    return false;
  }

References type_fifo, type_ignore, type_sem, type_signal, and type_unknown.

operator=() [1/2]

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

delete

operator=() [2/2]

poll_event& zpp::poll_event::operator= ( poll_event &&  )

delete

reset()

void zpp::poll_event::reset ( )

inlinenoexcept

reset event to non ready state

Definition at line 189 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
 
    m_event->state = K_POLL_STATE_NOT_READY;
  }

sem()

auto zpp::poll_event::sem ( )

inlinenoexcept

get access to the sem of the event

Warning

the event must be a sem event

Returns

a sem_ref that points to the registered sem

Definition at line 238 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag == (int)type_tag::type_sem);
    __ASSERT_NO_MSG(m_event->sem != nullptr);
 
    return sem_ref(m_event->sem);
  }

References type_sem.

signal()

auto zpp::poll_event::signal ( )

inlinenoexcept

get access to the signal of the event

Warning

the event must be a signal event

Returns

a borrowed_poll_signal that points to the registered signal

Definition at line 254 of file poll_event.hpp.

  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag == (int)type_tag::type_signal);
    __ASSERT_NO_MSG(m_event->signal != nullptr);
 
    return poll_signal_ref(m_event->signal);
  }

References type_signal.

---

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

• include/zpp/poll_event.hpp