join::join Constructor

Constructs a join messaging block.

join(
   size_t _NumInputs
);

join(
   size_t _NumInputs,
   filter_method const& _Filter
);

join(
   Scheduler& _PScheduler,
   size_t _NumInputs
);

join(
   Scheduler& _PScheduler,
   size_t _NumInputs,
   filter_method const& _Filter
);

join(
   ScheduleGroup& _PScheduleGroup,
   size_t _NumInputs
);

join(
   ScheduleGroup& _PScheduleGroup,
   size_t _NumInputs,
   filter_method const& _Filter
);

Parameters

• _NumInputs
  The number of inputs this join block will be allowed.

• _Filter
  A filter function which determines whether offered messages should be accepted.

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

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

Remarks

The runtime uses the default scheduler if you do not specify the _PScheduler or _PScheduleGroup parameters.

The type filter_method is a functor with signature bool (_Type const &) which is invoked by this join messaging block to determine whether or not it should accept an offered message.

Requirements

Header: agents.h

Namespace: concurrency

See Also

Reference

join Class

Scheduler Class

ScheduleGroup Class