tbb::flow::interface11::source_node< Output > Class Template Reference

An executable node that acts as a source, i.e. it has no predecessors. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::source_node< Output >:

Collaboration diagram for tbb::flow::interface11::source_node< Output >:

Public Types
typedef Output	output_type
	The type of the output message, which is complete. More...
typedef sender< output_type >::successor_type	successor_type
	The type of successors of this node. More...
typedef null_type	input_type

Public Member Functions
template<typename Body >
__TBB_NOINLINE_SYM	source_node (graph &g, Body body, bool is_active=true)
	Constructor for a node with a successor. More...
__TBB_NOINLINE_SYM	source_node (const source_node &src)
	Copy constructor. More...
	~source_node ()
	The destructor. More...
bool	register_successor (successor_type &r) __TBB_override
	Add a new successor to this node. More...
bool	remove_successor (successor_type &r) __TBB_override
	Removes a successor from this node. More...
bool	try_get (output_type &v) __TBB_override
	Request an item from the node. More...
bool	try_reserve (output_type &v) __TBB_override
	Reserves an item. More...
bool	try_release () __TBB_override
	Release a reserved item. More...
bool	try_consume () __TBB_override
	Consumes a reserved item. More...
void	activate ()
	Activates a node that was created in the inactive state. More...
template<typename Body >
Body	copy_function_object ()
Public Member Functions inherited from tbb::flow::interface11::graph_node
	graph_node (graph &g)
virtual	~graph_node ()
Public Member Functions inherited from tbb::flow::interface11::sender< Output >
virtual	~sender ()
virtual __TBB_DEPRECATED bool	register_successor (successor_type &r)=0
	Add a new successor to this node. More...
virtual __TBB_DEPRECATED bool	remove_successor (successor_type &r)=0
	Removes a successor from this node. More...

Protected Member Functions
void	reset_node (reset_flags f) __TBB_override
	resets the source_node to its initial state More...

Private Member Functions
bool	try_reserve_apply_body (output_type &v)
task *	create_put_task ()
void	spawn_put ()
	Spawns a task that applies the body. More...
task *	apply_body_bypass ()
	Applies the body. Returning SUCCESSFULLY_ENQUEUED okay; forward_task_bypass will handle it. More...

Private Attributes
spin_mutex	my_mutex
bool	my_active
bool	init_my_active
internal::source_body< output_type > *	my_body
internal::source_body< output_type > *	my_init_body
internal::broadcast_cache< output_type >	my_successors
bool	my_reserved
bool	my_has_cached_item
output_type	my_cached_item

Friends
class	internal::source_task_bypass< source_node< output_type > >

Additional Inherited Members
Public Attributes inherited from tbb::flow::interface11::sender< Output >
__TBB_DEPRECATED typedef Output	output_type
	The output type of this sender. More...
__TBB_DEPRECATED typedef receiver< Output >	successor_type
	The successor type for this node. More...
Protected Attributes inherited from tbb::flow::interface11::graph_node
graph &	my_graph
graph_node *	next
graph_node *	prev

Detailed Description

template<typename Output>
class tbb::flow::interface11::source_node< Output >

An executable node that acts as a source, i.e. it has no predecessors.

Definition at line 1179 of file flow_graph.h.

Member Typedef Documentation

input_type

template<typename Output >

typedef null_type tbb::flow::interface11::source_node< Output >::input_type

Definition at line 1190 of file flow_graph.h.

output_type

template<typename Output >

typedef Output tbb::flow::interface11::source_node< Output >::output_type

The type of the output message, which is complete.

Definition at line 1184 of file flow_graph.h.

successor_type

template<typename Output >

typedef sender<output_type>::successor_type tbb::flow::interface11::source_node< Output >::successor_type

The type of successors of this node.

Definition at line 1187 of file flow_graph.h.

Constructor & Destructor Documentation

source_node() [1/2]

template<typename Output >

template<typename Body >

__TBB_NOINLINE_SYM tbb::flow::interface11::source_node< Output >::source_node ( graph &  g, Body  body, bool  is_active = true  )

inline

Constructor for a node with a successor.

Definition at line 1199 of file flow_graph.h.

        : graph_node(g), my_active(is_active), init_my_active(is_active),
        my_body( new internal::source_body_leaf< output_type, Body>(body) ),
        my_init_body( new internal::source_body_leaf< output_type, Body>(body) ),
        my_reserved(false), my_has_cached_item(false)
    {
        my_successors.set_owner(this);
        tbb::internal::fgt_node_with_body( CODEPTR(), tbb::internal::FLOW_SOURCE_NODE, &this->my_graph,
                                           static_cast<sender<output_type> *>(this), this->my_body );
    }

References CODEPTR, and tbb::internal::fgt_node_with_body().

Here is the call graph for this function:

source_node() [2/2]

template<typename Output >

__TBB_NOINLINE_SYM tbb::flow::interface11::source_node< Output >::source_node ( const source_node< Output > &  src )

inline

Copy constructor.

Definition at line 1219 of file flow_graph.h.

                                                             :
        graph_node(src.my_graph), sender<Output>(),
        my_active(src.init_my_active),
        init_my_active(src.init_my_active), my_body( src.my_init_body->clone() ), my_init_body(src.my_init_body->clone() ),
        my_reserved(false), my_has_cached_item(false)
    {
        my_successors.set_owner(this);
        tbb::internal::fgt_node_with_body(CODEPTR(), tbb::internal::FLOW_SOURCE_NODE, &this->my_graph,
                                           static_cast<sender<output_type> *>(this), this->my_body );
    }

References CODEPTR, and tbb::internal::fgt_node_with_body().

Here is the call graph for this function:

~source_node()

template<typename Output >

tbb::flow::interface11::source_node< Output >::~source_node ( )

inline

The destructor.

Definition at line 1231 of file flow_graph.h.

{ delete my_body; delete my_init_body; }

Member Function Documentation

activate()

template<typename Output >

void tbb::flow::interface11::source_node< Output >::activate ( )

inline

Activates a node that was created in the inactive state.

Definition at line 1337 of file flow_graph.h.

                    {
        spin_mutex::scoped_lock lock(my_mutex);
        my_active = true;
        if (!my_successors.empty())
            spawn_put();
    }

References lock.

apply_body_bypass()

template<typename Output >

task* tbb::flow::interface11::source_node< Output >::apply_body_bypass ( )

inlineprivate

Applies the body. Returning SUCCESSFULLY_ENQUEUED okay; forward_task_bypass will handle it.

Definition at line 1430 of file flow_graph.h.

                                {
        output_type v;
        if ( !try_reserve_apply_body(v) )
            return NULL;
 
        task *last_task = my_successors.try_put_task(v);
        if ( last_task )
            try_consume();
        else
            try_release();
        return last_task;
    }

copy_function_object()

template<typename Output >

template<typename Body >

Body tbb::flow::interface11::source_node< Output >::copy_function_object ( )

inline

Definition at line 1345 of file flow_graph.h.

                                {
        internal::source_body<output_type> &body_ref = *this->my_body;
        return dynamic_cast< internal::source_body_leaf<output_type, Body> & >(body_ref).get_body();
    }

create_put_task()

template<typename Output >

task* tbb::flow::interface11::source_node< Output >::create_put_task ( )

inlineprivate

Definition at line 1416 of file flow_graph.h.

                            {
        return ( new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
                        internal:: source_task_bypass < source_node< output_type > >( *this ) );
    }

register_successor()

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::register_successor ( successor_type &  r )

inline

Add a new successor to this node.

Definition at line 1240 of file flow_graph.h.

                                                                {
        spin_mutex::scoped_lock lock(my_mutex);
        my_successors.register_successor(r);
        if ( my_active )
            spawn_put();
        return true;
    }

References lock.

remove_successor()

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::remove_successor ( successor_type &  r )

inline

Removes a successor from this node.

Definition at line 1249 of file flow_graph.h.

                                                              {
        spin_mutex::scoped_lock lock(my_mutex);
        my_successors.remove_successor(r);
        return true;
    }

References lock.

reset_node()

template<typename Output >

void tbb::flow::interface11::source_node< Output >::reset_node ( reset_flags  f )

inlineprotectedvirtual

resets the source_node to its initial state

Implements tbb::flow::interface11::graph_node.

Definition at line 1362 of file flow_graph.h.

                                                   {
        my_active = init_my_active;
        my_reserved =false;
        if(my_has_cached_item) {
            my_has_cached_item = false;
        }
        if(f & rf_clear_edges) my_successors.clear();
        if(f & rf_reset_bodies) {
            internal::source_body<output_type> *tmp = my_init_body->clone();
            delete my_body;
            my_body = tmp;
        }
        if(my_active)
            internal::add_task_to_graph_reset_list(this->my_graph, create_put_task());
    }

References tbb::flow::interface11::internal::add_task_to_graph_reset_list(), internal::source_body< Output >::clone(), tbb::flow::interface11::rf_clear_edges, and tbb::flow::interface11::rf_reset_bodies.

Here is the call graph for this function:

spawn_put()

template<typename Output >

void tbb::flow::interface11::source_node< Output >::spawn_put ( )

inlineprivate

Spawns a task that applies the body.

Definition at line 1422 of file flow_graph.h.

                      {
        if(internal::is_graph_active(this->my_graph)) {
            internal::spawn_in_graph_arena(this->my_graph, *create_put_task());
        }
    }

References tbb::flow::interface11::internal::is_graph_active(), and tbb::flow::interface11::internal::spawn_in_graph_arena().

Here is the call graph for this function:

try_consume()

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::try_consume ( )

inlinevirtual

Consumes a reserved item.

Reimplemented from tbb::flow::interface11::sender< Output >.

Definition at line 1325 of file flow_graph.h.

                                       {
        spin_mutex::scoped_lock lock(my_mutex);
        __TBB_ASSERT( my_reserved && my_has_cached_item, "consuming non-existent reservation" );
        my_reserved = false;
        my_has_cached_item = false;
        if ( !my_successors.empty() ) {
            spawn_put();
        }
        return true;
    }

References __TBB_ASSERT, and lock.

try_get()

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::try_get ( output_type &  v )

inlinevirtual

Request an item from the node.

Reimplemented from tbb::flow::interface11::sender< Output >.

Definition at line 1281 of file flow_graph.h.

                                                  {
        spin_mutex::scoped_lock lock(my_mutex);
        if ( my_reserved )
            return false;
 
        if ( my_has_cached_item ) {
            v = my_cached_item;
            my_has_cached_item = false;
            return true;
        }
        // we've been asked to provide an item, but we have none.  enqueue a task to
        // provide one.
        spawn_put();
        return false;
    }

References lock.

try_release()

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::try_release ( )

inlinevirtual

Release a reserved item.

true = item has been released and so remains in sender, dest must request or reserve future items

Reimplemented from tbb::flow::interface11::sender< Output >.

Definition at line 1315 of file flow_graph.h.

                                       {
        spin_mutex::scoped_lock lock(my_mutex);
        __TBB_ASSERT( my_reserved && my_has_cached_item, "releasing non-existent reservation" );
        my_reserved = false;
        if(!my_successors.empty())
            spawn_put();
        return true;
    }

References __TBB_ASSERT, and lock.

try_reserve()

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::try_reserve ( output_type &  v )

inlinevirtual

Reserves an item.

Reimplemented from tbb::flow::interface11::sender< Output >.

Definition at line 1298 of file flow_graph.h.

                                                      {
        spin_mutex::scoped_lock lock(my_mutex);
        if ( my_reserved ) {
            return false;
        }
 
        if ( my_has_cached_item ) {
            v = my_cached_item;
            my_reserved = true;
            return true;
        } else {
            return false;
        }
    }

References lock.

try_reserve_apply_body()

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::try_reserve_apply_body ( output_type &  v )

inlineprivate

Definition at line 1390 of file flow_graph.h.

                                                {
        spin_mutex::scoped_lock lock(my_mutex);
        if ( my_reserved ) {
            return false;
        }
        if ( !my_has_cached_item ) {
            tbb::internal::fgt_begin_body( my_body );
            bool r = (*my_body)(my_cached_item);
            tbb::internal::fgt_end_body( my_body );
            if (r) {
                my_has_cached_item = true;
            }
        }
        if ( my_has_cached_item ) {
            v = my_cached_item;
            my_reserved = true;
            return true;
        } else {
            return false;
        }
    }

References tbb::internal::fgt_begin_body(), tbb::internal::fgt_end_body(), and lock.

Here is the call graph for this function:

Friends And Related Function Documentation

internal::source_task_bypass< source_node< output_type > >

template<typename Output >

friend class internal::source_task_bypass< source_node< output_type > >

friend

Definition at line 1428 of file flow_graph.h.

Member Data Documentation

init_my_active

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::init_my_active

private

Definition at line 1381 of file flow_graph.h.

my_active

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::my_active

private

Definition at line 1380 of file flow_graph.h.

my_body

template<typename Output >

internal::source_body<output_type>* tbb::flow::interface11::source_node< Output >::my_body

private

Definition at line 1382 of file flow_graph.h.

my_cached_item

template<typename Output >

output_type tbb::flow::interface11::source_node< Output >::my_cached_item

private

Definition at line 1387 of file flow_graph.h.

my_has_cached_item

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::my_has_cached_item

private

Definition at line 1386 of file flow_graph.h.

my_init_body

template<typename Output >

internal::source_body<output_type>* tbb::flow::interface11::source_node< Output >::my_init_body

private

Definition at line 1383 of file flow_graph.h.

my_mutex

template<typename Output >

spin_mutex tbb::flow::interface11::source_node< Output >::my_mutex

private

Definition at line 1379 of file flow_graph.h.

my_reserved

template<typename Output >

bool tbb::flow::interface11::source_node< Output >::my_reserved

private

Definition at line 1385 of file flow_graph.h.

my_successors

template<typename Output >

internal::broadcast_cache< output_type > tbb::flow::interface11::source_node< Output >::my_successors

private

Definition at line 1384 of file flow_graph.h.

---

The documentation for this class was generated from the following file:

• flow_graph.h