buffer_node クラス

概要

T 型のメッセージの無制限バッファー。 メッセージは任意の順序で転送されます。

構文

template< typename T, typename A = cache_aligned_allocator<T> >
class buffer_node;

ヘッダー

#include "tbb/flow_graph.h"

説明

buffer_node は、後続 (successor) セットの 1 つの後続に任意の順序でメッセージを転送する graph_nodereceiver<T>sender<T> です。 ノードに登録された順で、後続にメッセージが転送されます。 後続がメッセージを拒否すると、その後続はメッセージ・パッシング・プロトコルのポリシーに従って後続リストから削除され、セットの次の後続が試されます。 この処理は後続がメッセージを受け取るまで、またはすべての後続が試されるまで続行されます。 後続に転送された項目はバッファーから削除されます。

buffer_node は予約可能で、一度に 1 つの予約をサポートします。 1 つの項目が予約されている間、ほかの項目は後続に転送され、try_get の呼び出しはほかに予約されていない項目がある場合はその項目を返します。 1 つの項目が予約されている間、try_puttrue を返し、バッファーに項目を追加します。

A 型のアロケーターが、buffer_node に内部メモリーを割り当てるために使用されます。

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

後続がメッセージを拒否した場合、メッセージ・パッシング・プロトコルを使用して処理されます (詳細は、以下のリンクを参照)。

メンバー

namespace tbb {
namespace flow {
 
 
template< typename T, typename A = cache_aligned_allocator<T> >
class buffer_node :
  public graph_node, public receiver<T>, public sender<T> {
public:
    buffer_node( graph &g );
    buffer_node( const buffer_node &src );
 
    // receiver<T>
    typedef T 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<T>
    typedef T 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( );
};
 
}
}
次の表は、このクラスのメンバーの詳細な情報を提供します。
メンバー 説明
buffer_node( graph &g )

graph g に属する空の buffer_node を構築します。

buffer_node( const buffer_node &src )

空の buffer_node を構築します。 バッファーに格納される値と後続のリストは src からコピーされません。

bool try_put( const input_type &v )

バッファーに v を追加します。 v がバッファーの唯一の項目の場合、項目を後続に転送するタスクがキューに入れられます。

戻り値: true

bool register_predecessor( predecessor_type &p )

値を拒否しないため、先行 (predecessor) のリストを維持する必要はありません。

戻り値: false

bool remove_predecessor( predecessor_type &p )

値を拒否しないため、先行のリストを維持する必要はありません。

戻り値: false

bool register_successor( successor_type &r )

後続のセットに r を追加します。

戻り値: true

bool remove_successor( successor_type &r )

後続のセットから r を削除します。

戻り値: true

bool try_get( output_type &v )

戻り値: バッファーから削除して v に代入できる項目がある場合は true。 バッファーに現在予約されていない項目がない場合は false

bool try_reserve( output_type &v )

現在保持されている予約がなく、バッファーに利用可能な項目が少なくとも 1 つある場合、新しく予約する項目を v に代入します。 新しい予約が行われると、バッファーは予約済みとしてマークされます。

戻り値: 新しく予約する項目が v に代入された場合は ture。 その他の場合は false

bool try_release( )

バッファーの予約を解除します。最後に成功した try_reserve の呼び出しで返された項目がバッファーに残されます。

戻り値: バッファーが現在予約されている場合は true。その他の場合は false

bool try_consume( )

バッファーの予約を解除します。最後に成功した try_reserve の呼び出しで返された項目がバッファーに残されます。

戻り値: バッファーが現在予約されている場合は true。その他の場合は false

関連情報