single_assignment 类
single_assignment 消息块是多目标、多源、有序的 propagator_block，能够存储单个一次写入的 message。
语法
template<class T>
class single_assignment : public propagator_block<multi_link_registry<ITarget<T>>, multi_link_registry<ISource<T>>>;
参数
T
缓冲区存储和传播的消息的有效负载类型。
成员
公共构造函数
| 名称 | 描述 |
|---|---|
| single_assignment | 已重载。 构造 single_assignment 消息块。 |
| ~single_assignment 析构函数 | 销毁 single_assignment 消息块。 |
公共方法
| 名称 | 描述 |
|---|---|
| has_value | 检查是否已使用值初始化此 single_assignment 消息块。 |
| value | 获取对 single_assignment 消息块中存储的消息的当前有效负载的引用。 |
受保护方法
| 名称 | 描述 |
|---|---|
| accept_message | 接受此 single_assignment 消息块提供的消息，将消息的副本返回到调用方。 |
| consume_message | 使用 single_assignment 之前提供且由目标保留的消息，将消息的副本返回到调用方。 |
| link_target_notification | 通知新目标已链接到 single_assignment 消息块的回调。 |
| propagate_message | 将消息从 ISource 块异步传递到 single_assignment 消息块。 它在被源块调用时由 propagate 方法调用。 |
| propagate_to_any_targets | 将 message _PMessage 置于此 single_assignment 消息块中，并将其提供给所有链接的目标。 |
| release_message | 释放先前的消息预留。 （替代 source_block::release_message。） |
| reserve_message | 保留此 single_assignment 消息块之前提供的消息。 （替代 source_block::reserve_message。） |
| resume_propagation | 在释放预留后恢复传播。 （重写 source_block::resume_propagation。） |
| send_message | 将消息从 ISource 块同步传递到 single_assignment 消息块。 它在被源块调用时由 send 方法调用。 |
注解
single_assignment 消息块将其消息的副本传播到每个目标。
有关详细信息，请参阅异步消息块。
继承层次结构
single_assignment
要求
标头： agents.h
命名空间： 并发
accept_message
接受此 single_assignment 消息块提供的消息，将消息的副本返回到调用方。
virtual message<T>* accept_message(runtime_object_identity _MsgId);
参数
_MsgId
提供的 message 对象的 runtime_object_identity。
返回值
指向调用方现在对其拥有所有权的 message 对象的指针。
注解
single_assignment 消息块将消息的副本返回到其目标，而不是转移当前保存的消息的所有权。
consume_message
使用 single_assignment 之前提供且由目标保留的消息，将消息的副本返回到调用方。
virtual message<T>* consume_message(runtime_object_identity _MsgId);
参数
_MsgId
正在使用的 message 对象的 runtime_object_identity。
返回值
指向调用方现在对其拥有所有权的 message 对象的指针。
注解
类似于 accept，但始终在对 reserve 的调用之前。
has_value
检查是否已使用值初始化此 single_assignment 消息块。
bool has_value() const;
返回值
如果此块已接收一个值，则为 true；否则为 false。
link_target_notification
通知新目标已链接到 single_assignment 消息块的回调。
virtual void link_target_notification(_Inout_ ITarget<T>* _PTarget);
参数
_PTarget
指向新链接的目标的指针。
propagate_message
将消息从 ISource 块异步传递到 single_assignment 消息块。 它在被源块调用时由 propagate 方法调用。
virtual message_status propagate_message(
_Inout_ message<T>* _PMessage,
_Inout_ ISource<T>* _PSource);
参数
_PMessage
指向 message 对象的指针。
_PSource
指向提供消息的源块的指针。
返回值
message_status 指示目标决定对消息执行的操作。
propagate_to_any_targets
将此message_PMessage消息块置于此single_assignment消息块中，并将其提供给所有链接的目标。
virtual void propagate_to_any_targets(_Inout_opt_ message<T>* _PMessage);
参数
_PMessage
指向此 single_assignment 消息块已拥有其所有权的 message 的指针。
release_message
释放先前的消息预留。
virtual void release_message(runtime_object_identity _MsgId);
参数
_MsgId
正在释放的 message 对象的 runtime_object_identity。
reserve_message
保留此 single_assignment 消息块之前提供的消息。
virtual bool reserve_message(runtime_object_identity _MsgId);
参数
_MsgId
正在保留的 message 对象的 runtime_object_identity。
返回值
如果已成功保留该消息，则为 true；否则，为 false。
备注
调用 reserve 后，如果返回 true，则必须调用 consume 或 release 来获取或释放消息的所有权。
resume_propagation
在释放预留后恢复传播。
virtual void resume_propagation();
send_message
将消息从 ISource 块同步传递到 single_assignment 消息块。 它在被源块调用时由 send 方法调用。
virtual message_status send_message(
_Inout_ message<T>* _PMessage,
_Inout_ ISource<T>* _PSource);
参数
_PMessage
指向 message 对象的指针。
_PSource
指向提供消息的源块的指针。
返回值
message_status 指示目标决定对消息执行的操作。
single_assignment
构造 single_assignment 消息块。
single_assignment();
single_assignment(
filter_method const& _Filter);
single_assignment(
Scheduler& _PScheduler);
single_assignment(
Scheduler& _PScheduler,
filter_method const& _Filter);
single_assignment(
ScheduleGroup& _PScheduleGroup);
single_assignment(
ScheduleGroup& _PScheduleGroup,
filter_method const& _Filter);
参数
_Filter
一个筛选器函数，用于确定是否应接受提供的消息。
_PScheduler
在其中计划了 Scheduler 消息块的传播任务的 single_assignment 对象。
_PScheduleGroup
在其中计划了 ScheduleGroup 消息块的传播任务的 single_assignment 对象。 所用 Scheduler 对象由该计划组提示。
备注
如果未指定 _PScheduler 或 _PScheduleGroup 函数，运行时将使用默认的计划程序。
类型 filter_method 是一个具有 bool (T const &) 签名的函子，由 single_assignment 消息块调用来确定它是否应接受提供的消息。
~single_assignment
销毁 single_assignment 消息块。
~single_assignment();
value
获取对 single_assignment 消息块中存储的消息的当前有效负载的引用。
T const& value();
返回值
存储的消息的有效负载。
备注
如果当前没有消息存储在 single_assignment 消息块中，此方法将等到有消息到达为止。