transformer 类

项目
10/15/2023

transformer 消息块是单目标、多源、有序的 propagator_block，它可以接受一个类型的消息，并能够存储不限数量的另一个类型的消息。

语法

template<class _Input, class _Output>
class transformer : public propagator_block<single_link_registry<ITarget<_Output>>,
    multi_link_registry<ISource<_Input>>>;

参数

_Input
缓冲区接受的消息的有效负载类型。

_Output
缓冲区存储和传播的消息的有效负载类型。

成员

公共构造函数

名称	描述
transformer	已重载。构造 `transformer` 消息块。
~transformer 析构函数	销毁 `transformer` 消息块。

受保护方法

名称	描述
accept_message	接受此 `transformer` 消息块提供的消息，将所有权转让给调用方。
consume_message	使用 `transformer` 先前提供且由目标保留的消息，将所有权转移给调用方。
link_target_notification	通知新目标已链接到 `transformer` 消息块的回调。
propagate_message	将消息从 `ISource` 块异步传递到 `transformer` 消息块。它在被源块调用时由 `propagate` 方法调用。
propagate_to_any_targets	执行输入消息中的转换器函数。
release_message	释放先前的消息预留。（替代 source_block::release_message。）
reserve_message	保留此 `transformer` 消息块之前提供的消息。（替代 source_block::reserve_message。）
resume_propagation	在释放预留后恢复传播。（重写 source_block::resume_propagation。）
send_message	将消息从 `ISource` 块同步传递到 `transformer` 消息块。它在被源块调用时由 `send` 方法调用。
supports_anonymous_source	重写 `supports_anonymous_source` 方法，以指示该块可以接受由未链接的源为其提供的消息。（替代 ITarget::supports_anonymous_source。）

备注

有关详细信息，请参阅异步消息块。

继承层次结构

transformer

要求

标头： agents.h

命名空间： 并发

accept_message

接受此 transformer 消息块提供的消息，将所有权转让给调用方。

virtual message<_Output>* accept_message(runtime_object_identity _MsgId);

参数

_MsgId
提供的 message 对象的 runtime_object_identity。

返回值

指向调用方现在对其拥有所有权的 message 对象的指针。

consume_message

使用 transformer 先前提供且由目标保留的消息，将所有权转移给调用方。

virtual message<_Output>* consume_message(runtime_object_identity _MsgId);

参数

_MsgId
正在使用的 message 对象的 runtime_object_identity。

返回值

指向调用方现在对其拥有所有权的 message 对象的指针。

注解

类似于 accept，但始终在对 reserve 的调用之前。

link_target_notification

通知新目标已链接到 transformer 消息块的回调。

virtual void link_target_notification(_Inout_ ITarget<_Output> *);

propagate_message

将消息从 ISource 块异步传递到 transformer 消息块。它在被源块调用时由 propagate 方法调用。

virtual message_status propagate_message(
    _Inout_ message<_Input>* _PMessage,
    _Inout_ ISource<_Input>* _PSource);

参数

_PMessage
指向 message 对象的指针。

_PSource
指向提供消息的源块的指针。

返回值

message_status 指示目标决定对消息执行的操作。

propagate_to_any_targets

执行输入消息中的转换器函数。

virtual void propagate_to_any_targets(_Inout_opt_ message<_Output> *);

release_message

释放先前的消息预留。

virtual void release_message(runtime_object_identity _MsgId);

参数

_MsgId
正在释放的 message 对象的 runtime_object_identity。

reserve_message

保留此 transformer 消息块之前提供的消息。

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 块同步传递到 transformer 消息块。它在被源块调用时由 send 方法调用。

virtual message_status send_message(
    _Inout_ message<_Input>* _PMessage,
    _Inout_ ISource<_Input>* _PSource);

参数

_PMessage
指向 message 对象的指针。

_PSource
指向提供消息的源块的指针。

返回值

message_status 指示目标决定对消息执行的操作。

supports_anonymous_source

重写 supports_anonymous_source 方法，以指示该块可以接受由未链接的源为其提供的消息。

virtual bool supports_anonymous_source();

返回值

true，因为该块没有推迟所提供的消息。

transformer

构造 transformer 消息块。

transformer(
    _Transform_method const& _Func,
    _Inout_opt_ ITarget<_Output>* _PTarget = NULL);

transformer(
    _Transform_method const& _Func,
    _Inout_opt_ ITarget<_Output>* _PTarget,
    filter_method const& _Filter);

transformer(
    Scheduler& _PScheduler,
    _Transform_method const& _Func,
    _Inout_opt_ ITarget<_Output>* _PTarget = NULL);

transformer(
    Scheduler& _PScheduler,
    _Transform_method const& _Func,
    _Inout_opt_ ITarget<_Output>* _PTarget,
    filter_method const& _Filter);

transformer(
    ScheduleGroup& _PScheduleGroup,
    _Transform_method const& _Func,
    _Inout_opt_ ITarget<_Output>* _PTarget = NULL);

transformer(
    ScheduleGroup& _PScheduleGroup,
    _Transform_method const& _Func,
    _Inout_opt_ ITarget<_Output>* _PTarget,
    filter_method const& _Filter);

参数

_Func
将为每个接受的消息调用的函数。

_PTarget
指向要与转换器链接的目标块的指针。

_Filter
一个筛选器函数，用于确定是否应接受提供的消息。

_PScheduler
在其中计划了 Scheduler 消息块的传播任务的 transformer 对象。

_PScheduleGroup
在其中计划了 ScheduleGroup 消息块的传播任务的 transformer 对象。所用 Scheduler 对象由该计划组提示。

备注

如果未指定 _PScheduler 或 _PScheduleGroup 函数，运行时将使用默认的计划程序。

类型 _Transform_method 是一个具有 _Output (_Input const &) 签名的函子，transformer 消息块调用它来处理消息。

类型 filter_method 是一个具有 bool (_Input const &) 签名的函子，由 transformer 消息块调用来确定它是否应接受提供的消息。

~transformer

销毁 transformer 消息块。

~transformer();

另请参阅

并发命名空间
 call 类