Template Class Conduit

Class Documentation

template<typename ImplSpec>
class uit::Conduit

Creates a coupled Inlet and Outlet.

Useful for intra-process transmission (i.e., intra-thread or inter-thread transmission) where conceptually-coupled Inlet’s and Outlet’s exist within the same memory space.

Template Parameters

  • ImplSpec: class with static and typedef members specifying implementation details for the conduit framework. See include/config/ImplSpec.hpp.

Public Types

using inlet_t = inlet_wrapper_t<uit::Inlet<ImplSpec>>
using outlet_t = outlet_wrapper_t<uit::Outlet<ImplSpec>>

Public Functions

Conduit(Conduit &other) = default

Copy constructor.

Conduit(const Conduit &other) = default

Copy constructor.

Conduit(Conduit &&other) = default

Move constructor.

template<typename ...Args>
Conduit(Args&&... args)

Forwarding constructor.

Use std::in_place_type_t<ImplType>{} followed by constructor arguments to initialize the Duct with ImplType active.

template<size_t N>
decltype(auto) get() const

Adaptor for structured bindings as interface to access Conduit’s Inlet or Outlet.

Return

Conduit’s Inlet or Outlet.

Template Parameters

  • N: Index of element to access, 0 for Inlet or 1 for Outlet.

inlet_t &GetInlet()

Accessor for Conduit’s Inlet.

Return

Conduit’s Inlet.

outlet_t &GetOutlet()

Accessor for Conduit’s Outlet.

Return

Conduit’s Inlet.