make_join Function

Constructs a non_greedy multitype_join messaging block from an optional Scheduler or ScheduleGroup and two or more input sources.

template<
   typename _Type1,
   typename _Type2,
   typename... _Types
>
multitype_join<std::tuple<_Type1, _Type2, _Types...>> make_join(
   Scheduler& _PScheduler,
   _Type1_Item1,
   _Type2_Item2,
   _Types... _Items
);

template<
   typename _Type1,
   typename _Type2,
   typename... _Types
>
multitype_join<std::tuple<_Type1, _Type2, _Types...>> make_join(
   ScheduleGroup& _PScheduleGroup,
   _Type1_Item1,
   _Type2_Item2,
   _Types... _Items
);

template<
   typename _Type1,
   typename _Type2,
   typename... _Types
>
multitype_join<std::tuple<_Type1, _Type2, _Types...>> make_join(
   _Type1_Item1,
   _Type2_Item2,
   _Types... _Items
);

Parameters

• _Type1
  The message block type of the first source.

• _Type2
  The message block type of the second source.

• _PScheduler
  The Scheduler object within which the propagation task for the multitype_join messaging block is scheduled.

• _Item1
  The first source.

• _Item2
  The second source.

• _Items
  Additional sources.

• _PScheduleGroup
  The ScheduleGroup object within which the propagation task for the multitype_join messaging block is scheduled. The Scheduler object used is implied by the schedule group.

Return Value

A non_greedy multitype_join message block with two or more input sources.

Requirements

Header: agents.h

Namespace: concurrency

See Also

Reference

concurrency Namespace

multitype_join Class

Scheduler Class

ScheduleGroup Class