async_node

[flow_graph.async_node]

フローグラフとユーザーまたは別のランタイムによって管理される外部アクティビティーとの通信を可能にするノード。


// <oneapi/tbb/flow_graph.h> ヘッダーで定義 

namespace oneapi { 
namespace tbb { 
namespace flow { 

    template < typename Input, typename Output, typename Policy = /*implemetation-defined*/ > 
    class async_node : public graph_node, public receiver<Input>, public sender<Output> { 
    public: 
        template<typename Body> 
        async_node( graph &g, size_t concurrency, Body body, Policy /*unspecified*/ = Policy(), 
                   node_priority_t priority = no_priority ); 
    
        template<typename Body> 
        async_node( graph &g, size_t concurrency, Body body, node_priority_t priority = no_priority ); 
    
        async_node( const async_node& src ); 
        ~async_node(); 
    
        using gateway_type = /*implementation-defined*/; 
        gateway_type& gateway(); 
    
        bool try_put( const input_type& v ); 
        bool try_get( output_type& v ); 
    }; 

} // namespace flow 
} // namespace tbb 
} // namespace oneapi

要件:

  • Inputタイプは、[defaultconstructible] の DefaultConstructible の要件と、[copyconstructible] ISO C++ 標準の CopyConstructible の要件を満たしている必要があります。

  • Policy タイプは、軽量、キューおよび拒否ポリシーまたはデフォルトにすることができます。

  • Body タイプは、AsyncNodeBody 要件を満たしている必要があります。

async_node は、着信メッセージに対するユーザー定義ボディーを実行します。グラフ外で処理するため、ボディーはメッセージを外部アクティビティーに送信します。メッセージを外部アクティビティーに渡すのは body の役割です。このノードは、外部アクティビティーがフローグラフと通信できるように gateway_type インターフェイスも提供します。

async_node は、graph_node、receiver<Input>、および sender<Output> です。

async_node には、discarding と broadcast-push プロパティーがあります。

async_node には、ユーザーが設定できる同時実行の制限があり、事前定義された値のいずれかに設定できます。ユーザーは、std::size_t タイプの値を 1 から tbb::flow::unlimited の間に設定して同時実行性を制限できます。

async_node に渡されたボディー・オブジェクトはコピーされます。メンバー変数を更新してもノードの作成に使用された元のオブジェクトには影響しません。ノードの外部からボディー・オブジェクト内に保持されている状態を確認する必要がある場合、copy_body 関数を使用して更新されたコピーを取得します。

メンバーのタイプ

gateway_type は、GatewayType 要件を満たします。

メンバー関数


template<typename Body> 
async_node( graph &g, size_t concurrency, Body body, 
              node_priority_t priority = no_priority );

body のコピーを呼び出す async_node を構築します。同時実行値は、ノードが同時に呼び出す body の数を制限します。

この関数はノードの優先順位を指定します。


template<typename Body> 
async_node( graph &g, size_t concurrency, Body body, Policy /*unspecified*/ = Policy(), 
              node_priority_t priority = no_priority );

body のコピーを呼び出す async_node を作成します。ほとんどの場合、body に対する concurrency の呼び出しは同時に行われます。

この関数は、ポリシーとノードの優先順位指定します。

async_node( const async_node &src )

src の作成時の状態と同じ初期状態で async_node を作成します。作成される async_node は src と同じ graph オブジェクトへの参照を持ち、src で使用される初期ボディーのコピーおよび src と同じ同時実行のしきい値を持ちます。src のプレデセッサーおよびサクセサーはコピーされせん。

新しいボディー・オブジェクトは、src の作成時に提供された元のボディーのコピー作成されます。src の作成後に src ボディーのメンバー変数に対して行われた変更は、新しい async_node のボディーには影響しません。

gateway_type& gateway()

gateway_type インターフェイスへの参照を返します。

bool try_put( const input_type& v )

同時実行の制限が適用されると、受信メッセージ v に対するユーザー定義 body を実行します。それ以外の場合は、ノードのポリシーに応じて受信メッセージ v をキューに投入するか拒否します。

戻り値: 入力が受け付けられた場合は true、それ以外は false を返します。

bool try_get( output_type& v )

戻り値: false