function_node テンプレート・クラス

概要

graph_node、receiver<Input>、sender<Output> のテンプレート・クラス。このノードには、ユーザーが設定する同時実行数の制限を適用できます。デフォルトで、function_node には入力に内部 FIFO バッファーがあります。同時実行数の制限により直ちに処理できないメッセージは、この FIFO バッファーに一時的に格納されます。テンプレートの引数で、この内部バッファーを無効にするように指定できます。FIFO バッファーが無効のときに、ノードの同時実行数の制限によりメッセージを直ちに処理できない場合、着信メッセージは拒否されます。

構文

template < typename Input,
           typename Output = continue_msg,
           graph_buffer_policy = queueing,
           typename A = cache_aligned_allocator<Input> >
class function_node;

ヘッダー

#include "tbb/flow_graph.h"

説明

function_node は、1 つの入力ポートで Input 型のメッセージを受け取り、すべてのサクセサーにブロードキャストされる Output 型の 1 つの出力メッセージを生成します。サクセサーがメッセージを拒否した場合、「メッセージ・パッシング・プロトコル」で説明されているプロトコルを使用して処理されます。

graph_buffer_policy == queueing の場合、内部の無制限入力バッファーが A 型のアロケーターから取得したメモリーを使用して維持されます。

function_node は、内部定数しきい値 T と内部カウンター C を維持します。構築時に、C = 0、T はコンストラクターに渡された値に設定されます。try_put 呼び出しの動作は、次の表のように、T と C の値によって決定されます。

function_node には、ユーザーが設定可能な同時実行数の制限が適用されます。flow::unlimited を指定すると、ボディーの無制限の呼び出しを同時に実行できます。flow::serial を指定すると、ボディーの 1 つの呼び出しのみ同時に実行できます。同時実行数を制限する size_t 型の値を 1 から unlimited の間で指定することもできます。

引数で graph_buffer_policy==rejecting を指定すると、function_node は、「メッセージ・パッシング・プロトコル」で説明されているようにプレデセッサー・セットを維持します。function_node の状態が C >= T から C < T に遷移すると、C >= T になるまで、またはセットに有効なプレデセッサーがなくなるまで、プレデセッサーのセットから新しいメッセージを取得しようとします。

Input と Output は、コピー構築可能および代入可能でなければなりません。

function_node のボディーコンセプトを次に示します。

メンバー

namespace tbb {
namespace flow {
 
enum graph_buffer_policy {
   rejecting, reserving, queueing, tag_matching };
 
template < typename Input, typename Output = continue_msg, 
           graph_buffer_policy = queueing, 
           typename A = cache_aligned_allocator<Input> >
class function_node :
  public graph_node, public receiver<Input>,
  public sender<Output> {
public:
    template<typename Body>
    function_node( graph &g, size_t concurrency, Body body );
    function_node( const function_node &src );
 
    // receiver<Input>
    typedef Input input_type;
    typedef sender<input_type> predecessor_type;
    bool try_put( const input_type &v );
    bool register_predecessor( predecessor_type &p );
    bool remove_predecessor( predecessor_type &p );
 
    // sender<Output>
    typedef Output output_type;
    typedef receiver<output_type> successor_type;
    bool register_successor( successor_type &r );
    bool remove_successor( successor_type &r );
    bool try_get( output_type &v );
    bool try_reserve( output_type &v );
    bool try_release( );
    bool try_consume( );
};
 
}
}