mtcore::thread::ReceiveOption< R, Callback > Struct Template Reference

Select option to receive a message and calls a callback on receive. More...

#include <select.hpp>

Collaboration diagram for mtcore::thread::ReceiveOption< R, Callback >:

Public Types
using	Message = typename R::Message

Public Member Functions
Result< void, SelectOptionErrors >	attempt ()
bool	prevents_deadlock () const noexcept

Public Attributes
R &	channel
Callback	callback

Detailed Description

template<Receiver R, typename Callback>
struct mtcore::thread::ReceiveOption< R, Callback >

Select option to receive a message and calls a callback on receive.

Template Parameters

R	Receiver to receive from
Callback	Callback on receive

Definition at line 286 of file select.hpp.

Member Typedef Documentation

Message

template<Receiver R, typename Callback>

using mtcore::thread::ReceiveOption< R, Callback >::Message = typename R::Message

Definition at line 287 of file select.hpp.

Member Function Documentation

attempt()

template<Receiver R, typename Callback>

Result< void, SelectOptionErrors > mtcore::thread::ReceiveOption< R, Callback >::attempt ( )

inline

Definition at line 291 of file select.hpp.

                                               {
      auto res = channel.try_receive();
      if (res.is_success()) {
        callback(res.value());
        return success();
      }
      return error(SelectOptionErrors::ATTEMPT_FAILED);
    }

Here is the call graph for this function:

prevents_deadlock()

template<Receiver R, typename Callback>

bool mtcore::thread::ReceiveOption< R, Callback >::prevents_deadlock ( ) const

inlinenodiscardnoexcept

Definition at line 300 of file select.hpp.

{ return true; }

Member Data Documentation

callback

template<Receiver R, typename Callback>

Callback mtcore::thread::ReceiveOption< R, Callback >::callback

Definition at line 289 of file select.hpp.

channel

template<Receiver R, typename Callback>

R& mtcore::thread::ReceiveOption< R, Callback >::channel

Definition at line 288 of file select.hpp.

---

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

• select.hpp