mtcore::thread::BroadcastSubscription< T > Struct Template Reference

A subscription to a broadcaster. More...

#include <broadcaster.hpp>

Collaboration diagram for mtcore::thread::BroadcastSubscription< T >:

Public Member Functions
Result< void, AllocationError >	init (Allocator &alloc)
Optional< T >	receive_block ()
void	deinit (Allocator &alloc)

Public Attributes
Arc< Inbox< T > >	inbox

Detailed Description

template<typename T>
struct mtcore::thread::BroadcastSubscription< T >

A subscription to a broadcaster.

Template Parameters

T	Type of elements that can be received

Definition at line 46 of file broadcaster.hpp.

Member Function Documentation

deinit()

template<typename T>

void mtcore::thread::BroadcastSubscription< T >::deinit ( Allocator & alloc )

inline

Definition at line 61 of file broadcaster.hpp.

                                  {
      if (inbox.valid()) {
        inbox->close();
      }
      inbox.release(alloc);
    }

Here is the caller graph for this function:

init()

template<typename T>

Result< void, AllocationError > mtcore::thread::BroadcastSubscription< T >::init ( Allocator & alloc )

inline

Definition at line 49 of file broadcaster.hpp.

                                                         {
      if (auto inboxRes = inbox.init(alloc); inboxRes.is_error()) {
        return inboxRes.error();
      }
      return inbox->init(alloc);
    }

Here is the caller graph for this function:

receive_block()

template<typename T>

Optional< T > mtcore::thread::BroadcastSubscription< T >::receive_block ( )

inline

Definition at line 56 of file broadcaster.hpp.

                                {
      ensure(inbox.valid(), "SUBSCRIPTION IS NOT INITIALIZED!");
      return inbox->receive_block();
    }

Member Data Documentation

inbox

template<typename T>

Arc<Inbox<T> > mtcore::thread::BroadcastSubscription< T >::inbox

Definition at line 47 of file broadcaster.hpp.

---

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

• broadcaster.hpp