STLdoc
STLdocumentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Concurrency::_Greedy_node< _Type > Class Template Reference

Helper class used in multi-type greedy join blocks Ordered node is a single-target, single-source ordered propagator block More...

#include <agents.h>

Inheritance diagram for Concurrency::_Greedy_node< _Type >:
Concurrency::_Order_node_base< _Type > Concurrency::propagator_block< single_link_registry< ITarget< size_t > >, multi_link_registry< ISource< _Type > > > Concurrency::source_block< single_link_registry< ITarget< size_t > >, _MessageProcessorType > Concurrency::ITarget< multi_link_registry< ISource< _Type > >::type::source_type > Concurrency::ISource< single_link_registry< ITarget< size_t > >::type::type >

Public Member Functions

 _Greedy_node (ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget=NULL)
 Constructs a _Greedy_node within the default scheduler, and places it on any schedule group of the scheduler's choosing. More...
 
 _Greedy_node (ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, filter_method const &_Filter)
 Constructs a _Greedy_node within the default scheduler, and places it on any schedule group of the scheduler's choosing. More...
 
 _Greedy_node (Scheduler &_PScheduler, ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget=NULL)
 Constructs a _Greedy_node within the specified scheduler, and places it on any schedule group of the scheduler's choosing. More...
 
 _Greedy_node (Scheduler &_PScheduler, ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, filter_method const &_Filter)
 Constructs a _Greedy_node within the specified scheduler, and places it on any schedule group of the scheduler's choosing. More...
 
 _Greedy_node (ScheduleGroup &_PScheduleGroup, ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget=NULL)
 Constructs a _Greedy_node within the specified schedule group. The scheduler is implied by the schedule group. More...
 
 _Greedy_node (ScheduleGroup &_PScheduleGroup, ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, filter_method const &_Filter)
 Constructs a _Greedy_node within the specified schedule group. The scheduler is implied by the schedule group. More...
 
 ~_Greedy_node ()
 Cleans up any resources that may have been created by the _Greedy_node. More...
 
void _Reset ()
 Resets the _Greedy_node and prepares it for the next propagation More...
 
- Public Member Functions inherited from Concurrency::_Order_node_base< _Type >
 _Order_node_base ()
 Constructs a _Order_node_base within the default scheduler, and places it on any schedule group of the scheduler's choosing. More...
 
 ~_Order_node_base ()
 Cleans up any resources that may have been created by the _Order_node. More...
 
bool has_value () const
 Checks whether this block has been initialized yet. More...
 
_Type const & value ()
 Gets a reference to the current payload of the message being stored. More...
 
virtual bool reserve_message (runtime_object_identity)
 Reserves a message previously offered by the source. More...
 
virtual message< size_t > * consume_message (runtime_object_identity)
 Consumes a message previously offered by the source and reserved by the target, transferring ownership to the caller. More...
 
virtual void release_message (runtime_object_identity)
 Releases a previous message reservation. More...
 
- Public Member Functions inherited from Concurrency::propagator_block< single_link_registry< ITarget< size_t > >, multi_link_registry< ISource< _Type > > >
 propagator_block ()
 Constructs a propagator_block object. More...
 
virtual ~propagator_block ()
 Destroys a propagator_block object. More...
 
virtual message_status propagate (_Inout_opt_ message< _Source_type > *_PMessage, _Inout_opt_ ISource< _Source_type > *_PSource)
 Asynchronously passes a message from a source block to this target block. More...
 
virtual message_status send (_Inout_ message< _Source_type > *_PMessage, _Inout_ ISource< _Source_type > *_PSource)
 Synchronously initiates a message to this block. Called by an ISource block. When this function completes, the message will already have propagated into the block. More...
 
- Public Member Functions inherited from Concurrency::source_block< single_link_registry< ITarget< size_t > >, _MessageProcessorType >
 source_block ()
 Constructs a source_block object. More...
 
virtual ~source_block ()
 Destroys the source_block object. More...
 
virtual void link_target (_Inout_ ITarget< _Target_type > *_PTarget)
 Links a target block to this source_block object. More...
 
virtual void unlink_target (_Inout_ ITarget< _Target_type > *_PTarget)
 Unlinks a target block from this source_block object. More...
 
virtual void unlink_targets ()
 Unlinks all target blocks from this source_block object. More...
 
virtual message< _Target_type > * accept (runtime_object_identity _MsgId, _Inout_ ITarget< _Target_type > *_PTarget)
 Accepts a message that was offered by this source_block object, transferring ownership to the caller. More...
 
virtual bool reserve (runtime_object_identity _MsgId, _Inout_ ITarget< _Target_type > *_PTarget)
 Reserves a message previously offered by this source_block object. More...
 
virtual message< _Target_type > * consume (runtime_object_identity _MsgId, _Inout_ ITarget< _Target_type > *_PTarget)
 Consumes a message previously offered by this source_block object and successfully reserved by the target, transferring ownership to the caller. More...
 
virtual void release (runtime_object_identity _MsgId, _Inout_ ITarget< _Target_type > *_PTarget)
 Releases a previous successful message reservation. More...
 
virtual void acquire_ref (_Inout_ ITarget< _Target_type > *)
 Acquires a reference count on this source_block object, to prevent deletion. More...
 
virtual void release_ref (_Inout_ ITarget< _Target_type > *_PTarget)
 Releases a reference count on this source_block object. More...
 
- Public Member Functions inherited from Concurrency::ISource< single_link_registry< ITarget< size_t > >::type::type >
virtual ~ISource ()
 Destroys the ISource object. More...
 
virtual void link_target (_Inout_ ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PTarget)=0
 When overridden in a derived class, links a target block to this ISource block. More...
 
virtual void unlink_target (_Inout_ ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PTarget)=0
 When overridden in a derived class, unlinks a target block from this ISource block, if found to be previously linked. More...
 
virtual message< single_link_registry< ITarget< size_t > >::type::type > * accept (runtime_object_identity _MsgId, _Inout_ ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PTarget)=0
 When overridden in a derived class, accepts a message that was offered by this ISource block, transferring ownership to the caller. More...
 
virtual bool reserve (runtime_object_identity _MsgId, _Inout_ ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PTarget)=0
 When overridden in a derived class, reserves a message previously offered by this ISource block. More...
 
virtual message< single_link_registry< ITarget< size_t > >::type::type > * consume (runtime_object_identity _MsgId, _Inout_ ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PTarget)=0
 When overridden in a derived class, consumes a message previously offered by this ISource block and successfully reserved by the target, transferring ownership to the caller. More...
 
virtual void release (runtime_object_identity _MsgId, _Inout_ ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PTarget)=0
 When overridden in a derived class, releases a previous successful message reservation. More...
 
virtual void acquire_ref (_Inout_ ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PTarget)=0
 When overridden in a derived class, acquires a reference count on this ISource block, to prevent deletion. More...
 
virtual void release_ref (_Inout_ ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PTarget)=0
 When overridden in a derived class, releases a reference count on this ISource block. More...
 
- Public Member Functions inherited from Concurrency::ITarget< multi_link_registry< ISource< _Type > >::type::source_type >
virtual ~ITarget ()
 Destroys the ITarget object. More...
 
virtual message_status propagate (_Inout_opt_ message< multi_link_registry< ISource< _Type > >::type::source_type > *_PMessage, _Inout_opt_ ISource< multi_link_registry< ISource< _Type > >::type::source_type > *_PSource)=0
 When overridden in a derived class, asynchronously passes a message from a source block to this target block. More...
 
virtual message_status send (_Inout_ message< multi_link_registry< ISource< _Type > >::type::source_type > *_PMessage, _Inout_ ISource< multi_link_registry< ISource< _Type > >::type::source_type > *_PSource)=0
 When overridden in a derived class, synchronously passes a message to the target block. More...
 
virtual bool supports_anonymous_source ()
 When overridden in a derived class, returns true or false depending on whether the message block accepts messages offered by a source that is not linked to it. If the overridden method returns true, the target cannot postpone an offered message, as consumption of a postponed message at a later time requires the source to be identified in its sourse link registry. More...
 

Protected Member Functions

virtual message_status propagate_message (message< _Type > *_PMessage, ISource< _Type > *_PSource)
 Asynchronously passes a message from an ISource block to this ITarget block. It is invoked by the propagate method, when called by a source block. More...
 
virtual message< size_t > * accept_message (runtime_object_identity _MsgId)
 Accept the message by making a copy of the payload. More...
 
virtual void propagate_to_any_targets (_Inout_opt_ message< size_t > *)
 Takes the message and propagates it to all the targets of this _Greedy_node More...
 
- Protected Member Functions inherited from Concurrency::_Order_node_base< _Type >
virtual void resume_propagation ()
 Resumes propagation after a reservation has been released More...
 
virtual void link_target_notification (_Inout_ ITarget< size_t > *)
 Notification that a target was linked to this source. More...
 
void _Create_send_message ()
 Create a message that contains an index used to determine the source message More...
 
void _Initialize_order_node (ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, Scheduler *_PScheduler=NULL, ScheduleGroup *_PScheduleGroup=NULL)
 Validate constructor arguments and fully connect this _Order_node_base. More...
 
- Protected Member Functions inherited from Concurrency::propagator_block< single_link_registry< ITarget< size_t > >, multi_link_registry< ISource< _Type > > >
virtual message_status propagate_message (_Inout_ message< _Source_type > *_PMessage, _Inout_ ISource< _Source_type > *_PSource)=0
 When overridden in a derived class, this method asynchronously passes a message from an ISource block to this propagator_block object. It is invoked by the propagate method, when called by a source block. More...
 
virtual message_status send_message (_Inout_ message< _Source_type > *, _Inout_ ISource< _Source_type > *)
 When overridden in a derived class, this method synchronously passes a message from an ISource block to this propagator_block object. It is invoked by the send method, when called by a source block. More...
 
virtual void link_source (_Inout_ ISource< _Source_type > *_PSource)
 Links a specified source block to this propagator_block object. More...
 
virtual void unlink_source (_Inout_ ISource< _Source_type > *_PSource)
 Unlinks a specified source block from this propagator_block object. More...
 
virtual void unlink_sources ()
 Unlinks all source blocks from this propagator_block object. More...
 
virtual void process_input_messages (_Inout_ message< _Target_type > *_PMessage)
 Process input messages. This is only useful for propagator blocks, which derive from source_block More...
 
void initialize_source_and_target (_Inout_opt_ Scheduler *_PScheduler=NULL, _Inout_opt_ ScheduleGroup *_PScheduleGroup=NULL)
 Initializes the base object. Specifically, the message_processor object needs to be initialized. More...
 
void register_filter (filter_method const &_Filter)
 Registers a filter method that will be invoked on every received message. More...
 
void decline_incoming_messages ()
 Indicates to the block that new messages should be declined. More...
 
void remove_network_links ()
 Removes all the source and target network links from this propagator_block object. More...
 
- Protected Member Functions inherited from Concurrency::source_block< single_link_registry< ITarget< size_t > >, _MessageProcessorType >
virtual void link_target_notification (_Inout_ ITarget< _Target_type > *)
 A callback that notifies that a new target has been linked to this source_block object. More...
 
virtual void unlink_target_notification (_Inout_ ITarget< _Target_type > *_PTarget)
 A callback that notifies that a target has been unlinked from this source_block object. More...
 
virtual void propagate_output_messages ()
 Propagate messages to targets. More...
 
virtual void propagate_to_any_targets (_Inout_opt_ message< _Target_type > *_PMessage)
 When overridden in a derived class, propagates the given message to any or all of the linked targets. This is the main propagation routine for message blocks. More...
 
void initialize_source (_Inout_opt_ Scheduler *_PScheduler=NULL, _Inout_opt_ ScheduleGroup *_PScheduleGroup=NULL)
 Initializes the message_propagator within this source_block. More...
 
void enable_batched_processing ()
 Enables batched processing for this block. More...
 
virtual void sync_send (_Inout_opt_ message< _Target_type > *_Msg)
 Synchronously queues up messages and starts a propagation task, if this has not been done already. More...
 
virtual void async_send (_Inout_opt_ message< _Target_type > *_Msg)
 Asynchronously queues up messages and starts a propagation task, if this has not been done already More...
 
void wait_for_outstanding_async_sends ()
 Waits for all asynchronous propagations to complete. This propagator-specific spin wait is used in destructors of message blocks to make sure that all asynchronous propagations have time to finish before destroying the block. More...
 
void remove_targets ()
 Removes all target links for this source block. This should be called from the destructor. More...
 
- Protected Member Functions inherited from Concurrency::ISource< single_link_registry< ITarget< size_t > >::type::type >
void _Invoke_link_source (ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PLinkFrom)
 Links this source to a target. More...
 
void _Invoke_unlink_source (ITarget< single_link_registry< ITarget< size_t > >::type::type > *_PUnlinkFrom)
 Unlinks this source from a target. More...
 
- Protected Member Functions inherited from Concurrency::ITarget< multi_link_registry< ISource< _Type > >::type::source_type >
virtual void link_source (_Inout_ ISource< multi_link_registry< ISource< _Type > >::type::source_type > *_PSource)=0
 When overridden in a derived class, links a specified source block to this ITarget block. More...
 
virtual void unlink_source (_Inout_ ISource< multi_link_registry< ISource< _Type > >::type::source_type > *_PSource)=0
 When overridden in a derived class, unlinks a specified source block from this ITarget block. More...
 

Private Member Functions

_Greedy_node const & operator= (_Greedy_node const &)
 
 _Greedy_node (_Greedy_node const &)
 

Private Attributes

message< _Type > * _M_pGreedyMessage
 
::Concurrency::details::_NonReentrantPPLLock _M_propagationLock
 
::Concurrency::details::_ReentrantPPLLock _M_resetLock
 
runtime_object_identity _M_savedId
 

Additional Inherited Members

- Public Types inherited from Concurrency::propagator_block< single_link_registry< ITarget< size_t > >, multi_link_registry< ISource< _Type > > >
typedef multi_link_registry< ISource< _Type > >::type::source_type _Source_type
 The type of the payload for the incoming message to this propagator_block. More...
 
typedef source_link_manager< multi_link_registry< ISource< _Type > > > _SourceLinkManager
 The type of the source_link_manager this propagator_block. More...
 
typedef _SourceLinkManager::iterator source_iterator
 The type of the iterator for the source_link_manager for this propagator_block. More...
 
- Public Types inherited from Concurrency::source_block< single_link_registry< ITarget< size_t > >, _MessageProcessorType >
typedef single_link_registry< ITarget< size_t > >::type::type _Target_type
 The payload type of messages handled by this source_block. More...
 
typedef single_link_registry< ITarget< size_t > >::iterator target_iterator
 The iterator to walk the connected targets. More...
 
- Public Types inherited from Concurrency::ISource< single_link_registry< ITarget< size_t > >::type::type >
typedef single_link_registry< ITarget< size_t > >::type::type source_type
 A type alias for _Type . More...
 
- Public Types inherited from Concurrency::ITarget< multi_link_registry< ISource< _Type > >::type::source_type >
typedef multi_link_registry< ISource< _Type > >::type::source_type type
 A type alias for _Type . More...
 
typedef std::tr1::function< bool(multi_link_registry< ISource< _Type > >::type::source_typeconst &)> filter_method
 The signature of any method used by the block that returns a bool value to determine whether an offered message should be accepted. More...
 
- Protected Attributes inherited from Concurrency::_Order_node_base< _Type >
message< _Type > * _M_pReceiveMessage
 
message< size_t > * _M_pSendMessage
 
size_t _M_index
 
- Protected Attributes inherited from Concurrency::propagator_block< single_link_registry< ITarget< size_t > >, multi_link_registry< ISource< _Type > > >
_SourceLinkManager _M_connectedSources
 The container for all the sources connected to this block. More...
 
filter_method_M_pFilter
 The filter function which determines whether offered messages should be accepted. More...
 
volatile bool _M_fDeclineMessages
 A bool that is set to indicate that all messages should be declined in preparation for deleting the block More...
 
- Protected Attributes inherited from Concurrency::source_block< single_link_registry< ITarget< size_t > >, _MessageProcessorType >
ITarget< _Target_type > * _M_pReservedFor
 Connected target that is holding a reservation More...
 
runtime_object_identity _M_reservedId
 Reserved message ID More...
 
single_link_registry< ITarget< size_t > > _M_connectedTargets
 Connected targets More...
 
_MessageProcessorType _M_messageProcessor
 Processor used for asynchronous message handling More...
 

Detailed Description

template<class _Type>
class Concurrency::_Greedy_node< _Type >

Helper class used in multi-type greedy join blocks Ordered node is a single-target, single-source ordered propagator block

Template Parameters
_TypeThe payload type

Constructor & Destructor Documentation

template<class _Type >
Concurrency::_Greedy_node< _Type >::_Greedy_node ( ISource< _Type > *  _PSource,
size_t  _Index,
ITarget< size_t > *  _PTarget = NULL 
)
inline

Constructs a _Greedy_node within the default scheduler, and places it on any schedule group of the scheduler's choosing.

Parameters
_PSourceThe source of data passed into the node
_IndexThe node's index, assigned from the outside.
_PTargetThe target to which the node will signal about having received its input data
8896  :
8897  _M_savedId(-1),
8899  {
8900  _Initialize_order_node(_PSource, _Index, _PTarget);
8901  }
void _Initialize_order_node(ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, Scheduler *_PScheduler=NULL, ScheduleGroup *_PScheduleGroup=NULL)
Validate constructor arguments and fully connect this _Order_node_base.
Definition: agents.h:8440
#define NULL
Definition: crtdbg.h:30
runtime_object_identity _M_savedId
Definition: agents.h:9243
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
Concurrency::_Greedy_node< _Type >::_Greedy_node ( ISource< _Type > *  _PSource,
size_t  _Index,
ITarget< size_t > *  _PTarget,
filter_method const &  _Filter 
)
inline

Constructs a _Greedy_node within the default scheduler, and places it on any schedule group of the scheduler's choosing.

Parameters
_PSourceThe source of data passed into the node
_IndexThe node's index, assigned from the outside.
_PTargetThe target to which the node will signal about having received its input data
_FilterA reference to a filter function.
8920  :
8921  _M_savedId(-1),
8923  {
8924  register_filter(_Filter);
8925  _Initialize_order_node(_PSource, _Index, _PTarget);
8926  }
void _Initialize_order_node(ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, Scheduler *_PScheduler=NULL, ScheduleGroup *_PScheduleGroup=NULL)
Validate constructor arguments and fully connect this _Order_node_base.
Definition: agents.h:8440
#define NULL
Definition: crtdbg.h:30
void register_filter(filter_method const &_Filter)
Registers a filter method that will be invoked on every received message.
Definition: agents.h:4188
runtime_object_identity _M_savedId
Definition: agents.h:9243
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
Concurrency::_Greedy_node< _Type >::_Greedy_node ( Scheduler &  _PScheduler,
ISource< _Type > *  _PSource,
size_t  _Index,
ITarget< size_t > *  _PTarget = NULL 
)
inline

Constructs a _Greedy_node within the specified scheduler, and places it on any schedule group of the scheduler's choosing.

Parameters
_PSchedulerA reference to a scheduler instance.
_PSourceThe source of data passed into the node
_IndexThe node's index, assigned from the outside.
_PTargetThe target to which the node will signal about having received its input data
8945  :
8946  _M_savedId(-1),
8948  {
8949  _Initialize_order_node(_PSource, _Index, _PTarget, &_PScheduler);
8950  }
void _Initialize_order_node(ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, Scheduler *_PScheduler=NULL, ScheduleGroup *_PScheduleGroup=NULL)
Validate constructor arguments and fully connect this _Order_node_base.
Definition: agents.h:8440
#define NULL
Definition: crtdbg.h:30
runtime_object_identity _M_savedId
Definition: agents.h:9243
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
Concurrency::_Greedy_node< _Type >::_Greedy_node ( Scheduler &  _PScheduler,
ISource< _Type > *  _PSource,
size_t  _Index,
ITarget< size_t > *  _PTarget,
filter_method const &  _Filter 
)
inline

Constructs a _Greedy_node within the specified scheduler, and places it on any schedule group of the scheduler's choosing.

Parameters
_PSchedulerA reference to a scheduler instance.
_PSourceThe source of data passed into the node
_IndexThe node's index, assigned from the outside.
_PTargetThe target to which the node will signal about having received its input data
_FilterA reference to a filter function.
8972  :
8973  _M_savedId(-1),
8975  {
8976  register_filter(_Filter);
8977  _Initialize_order_node(_PSource, _Index, _PTarget, &_PScheduler);
8978  }
void _Initialize_order_node(ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, Scheduler *_PScheduler=NULL, ScheduleGroup *_PScheduleGroup=NULL)
Validate constructor arguments and fully connect this _Order_node_base.
Definition: agents.h:8440
#define NULL
Definition: crtdbg.h:30
void register_filter(filter_method const &_Filter)
Registers a filter method that will be invoked on every received message.
Definition: agents.h:4188
runtime_object_identity _M_savedId
Definition: agents.h:9243
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
Concurrency::_Greedy_node< _Type >::_Greedy_node ( ScheduleGroup &  _PScheduleGroup,
ISource< _Type > *  _PSource,
size_t  _Index,
ITarget< size_t > *  _PTarget = NULL 
)
inline

Constructs a _Greedy_node within the specified schedule group. The scheduler is implied by the schedule group.

Parameters
_PScheduleGroupA reference to a schedule group.
_PSourceThe source of data passed into the node
_IndexThe node's index, assigned from the outside.
_PTargetThe target to which the node will signal about having received its input data
8997  :
8998  _M_savedId(-1),
9000  {
9001  _Initialize_order_node(_PSource, _Index, _PTarget, NULL, &_PScheduleGroup);
9002  }
void _Initialize_order_node(ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, Scheduler *_PScheduler=NULL, ScheduleGroup *_PScheduleGroup=NULL)
Validate constructor arguments and fully connect this _Order_node_base.
Definition: agents.h:8440
#define NULL
Definition: crtdbg.h:30
runtime_object_identity _M_savedId
Definition: agents.h:9243
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
Concurrency::_Greedy_node< _Type >::_Greedy_node ( ScheduleGroup &  _PScheduleGroup,
ISource< _Type > *  _PSource,
size_t  _Index,
ITarget< size_t > *  _PTarget,
filter_method const &  _Filter 
)
inline

Constructs a _Greedy_node within the specified schedule group. The scheduler is implied by the schedule group.

Parameters
_PScheduleGroupA reference to a schedule group.
_PSourceThe source of data passed into the node
_IndexThe node's index, assigned from the outside.
_PTargetThe target to which the node will signal about having received its input data
_FilterA reference to a filter function.
9024  :
9025  _M_savedId(-1),
9027  {
9028  register_filter(_Filter);
9029  _Initialize_order_node(_PSource, _Index, _PTarget, NULL, &_PScheduleGroup);
9030  }
void _Initialize_order_node(ISource< _Type > *_PSource, size_t _Index, ITarget< size_t > *_PTarget, Scheduler *_PScheduler=NULL, ScheduleGroup *_PScheduleGroup=NULL)
Validate constructor arguments and fully connect this _Order_node_base.
Definition: agents.h:8440
#define NULL
Definition: crtdbg.h:30
void register_filter(filter_method const &_Filter)
Registers a filter method that will be invoked on every received message.
Definition: agents.h:4188
runtime_object_identity _M_savedId
Definition: agents.h:9243
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
Concurrency::_Greedy_node< _Type >::~_Greedy_node ( )
inline

Cleans up any resources that may have been created by the _Greedy_node.

9037  {
9038  // Remove all links
9040 
9042  {
9043  delete _M_pGreedyMessage;
9044  }
9045  }
message< _Type > * _M_pReceiveMessage
Definition: agents.h:8473
void remove_network_links()
Removes all the source and target network links from this propagator_block object.
Definition: agents.h:4212
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
Concurrency::_Greedy_node< _Type >::_Greedy_node ( _Greedy_node< _Type > const &  )
private

Member Function Documentation

template<class _Type >
void Concurrency::_Greedy_node< _Type >::_Reset ( )
inlinevirtual

Resets the _Greedy_node and prepares it for the next propagation

_Reset is called from Populate_destination_tuple through propagate_to_any_targets() thus, it always has the internal lock held.

Implements Concurrency::_Order_node_base< _Type >.

9056  {
9057  _R_lock _Lock(_M_resetLock);
9058 
9059  delete _M_pReceiveMessage;
9061 
9062  delete _M_pSendMessage;
9064 
9065  //
9066  // For greedy type joins, look to see if any other messages have been
9067  // passed to this _Greedy_node while the join was waiting for other
9068  // messages to arrive. This function is already called with _M_resetLock
9069  // held through propagate_to_any_targets().
9070  //
9071  for(;;)
9072  {
9073  // Set the current saved ID as -1. Check to see if something was ready for consumption
9074  // (if _Saved_id != -1) and consume it if possible.
9075  runtime_object_identity _Saved_id;
9076 
9077  {
9078  _NR_lock lockHolder(_M_propagationLock);
9079 
9080  _Saved_id = _M_savedId;
9081 
9082  if (_Saved_id == -1)
9083  {
9085  break;
9086  }
9087  else
9088  {
9089  _M_savedId = -1;
9090  }
9091  }
9092 
9093  if (_Saved_id != -1)
9094  {
9096 
9097  ISource<_Type> * _PSource = *_Iter;
9098  if ((_PSource != NULL) && _PSource->reserve(_Saved_id, this))
9099  {
9100  _M_pGreedyMessage = _PSource->consume(_Saved_id, this);
9101  async_send(NULL);
9102  break;
9103  }
9104  }
9105  }
9106  }
::Concurrency::details::_ReentrantPPLLock _M_resetLock
Definition: agents.h:9239
#define NULL
Definition: crtdbg.h:30
__int32 runtime_object_identity
Each message instance has an identity that follows it as it is cloned and passed between messaging co...
Definition: agents.h:50
message< _Type > * _M_pReceiveMessage
Definition: agents.h:8473
::Concurrency::details::_ReentrantPPLLock::_Scoped_lock _R_lock
A lock holder that acquires a reentrant lock on instantiation and releases it on destruction ...
Definition: agents.h:64
::Concurrency::details::_NonReentrantPPLLock::_Scoped_lock _NR_lock
A lock holder that acquires a non-reentrant lock on instantiation and releases it on destruction...
Definition: agents.h:57
_SourceLinkManager _M_connectedSources
The container for all the sources connected to this block.
Definition: agents.h:4230
message< size_t > * _M_pSendMessage
Definition: agents.h:8476
::Concurrency::details::_NonReentrantPPLLock _M_propagationLock
Definition: agents.h:9236
_SourceLinkManager::iterator source_iterator
The type of the iterator for the source_link_manager for this propagator_block.
Definition: agents.h:3946
runtime_object_identity _M_savedId
Definition: agents.h:9243
virtual void async_send(_Inout_opt_ message< _Target_type > *_Msg)
Asynchronously queues up messages and starts a propagation task, if this has not been done already ...
Definition: agents.h:3783
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
virtual message<size_t>* Concurrency::_Greedy_node< _Type >::accept_message ( runtime_object_identity  _MsgId)
inlineprotectedvirtual

Accept the message by making a copy of the payload.

Parameters
_MsgIdThe runtime object identity of the message.
Returns
A pointer to the message that the caller now has ownership of.

Implements Concurrency::source_block< single_link_registry< ITarget< size_t > >, _MessageProcessorType >.

9179  {
9180  // This check is to prevent spoofing and verify that the propagated message is
9181  // the one that is accepted at the end.
9182  if (_M_pSendMessage == NULL || _MsgId != _M_pSendMessage->msg_id())
9183  {
9184  return NULL;
9185  }
9186 
9187  //
9188  // Instead of returning the internal message, we return a copy of the
9189  // message passed in.
9190  //
9191  // Because we are returning a copy, the accept routine for a _Greedy_node
9192  // does not need to grab the internal lock.
9193  //
9194  return (new message<size_t>(_M_pSendMessage->payload));
9195  }
#define NULL
Definition: crtdbg.h:30
runtime_object_identity msg_id() const
Returns the ID of the message object.
Definition: agents.h:1860
_Type const payload
The payload of the message object.
Definition: agents.h:1869
message< size_t > * _M_pSendMessage
Definition: agents.h:8476
template<class _Type >
_Greedy_node const& Concurrency::_Greedy_node< _Type >::operator= ( _Greedy_node< _Type > const &  )
private
template<class _Type >
virtual message_status Concurrency::_Greedy_node< _Type >::propagate_message ( message< _Type > *  _PMessage,
ISource< _Type > *  _PSource 
)
inlineprotectedvirtual

Asynchronously passes a message from an ISource block to this ITarget block. It is invoked by the propagate method, when called by a source block.

Parameters
_PMessageA pointer to the message object.
_PSourceA pointer to the source block offering the message.
Returns
A message_status indication of what the target decided to do with the message.

It is important that calls to propagate do not take the same lock on the internal structure that is used by Consume and the light-weight task. Doing so could result in a deadlock with the Consume call.

9135  {
9136  message_status _Result = postponed;
9137 
9138  bool _FDone = false;
9139 
9140  {
9141  _NR_lock lockHolder(_M_propagationLock);
9142  if (_M_pGreedyMessage != NULL)
9143  {
9144  _M_savedId = _PMessage->msg_id();
9145  _Result = postponed;
9146  _FDone = true;
9147  }
9148  }
9149 
9150  if (!_FDone)
9151  {
9152  _M_pGreedyMessage = _PSource->accept(_PMessage->msg_id(), this);
9153 
9154  if (_M_pGreedyMessage != NULL)
9155  {
9156  _Result = accepted;
9157  async_send(NULL);
9158  }
9159  else
9160  {
9161  _Result = missed;
9162  }
9163  }
9164 
9165  return _Result;
9166  }
The target postponed the message.
Definition: agents.h:1755
#define NULL
Definition: crtdbg.h:30
message_status
The valid responses for an offer of a message object to a block.
Definition: agents.h:1739
The target tried to accept the message, but it was no longer available.
Definition: agents.h:1760
The target accepted the message.
Definition: agents.h:1745
::Concurrency::details::_NonReentrantPPLLock::_Scoped_lock _NR_lock
A lock holder that acquires a non-reentrant lock on instantiation and releases it on destruction...
Definition: agents.h:57
::Concurrency::details::_NonReentrantPPLLock _M_propagationLock
Definition: agents.h:9236
runtime_object_identity _M_savedId
Definition: agents.h:9243
virtual void async_send(_Inout_opt_ message< _Target_type > *_Msg)
Asynchronously queues up messages and starts a propagation task, if this has not been done already ...
Definition: agents.h:3783
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233
template<class _Type >
virtual void Concurrency::_Greedy_node< _Type >::propagate_to_any_targets ( _Inout_opt_ message< size_t > *  )
inlineprotectedvirtual

Takes the message and propagates it to all the targets of this _Greedy_node

Parameters
_PMessageA pointer to a new message.

This function packages its _M_index into a message and immediately sends it to the targets.

9209  {
9210  _R_lock _Lock(_M_resetLock);
9211 
9212  if (_M_pSendMessage == NULL)
9213  {
9214  // Save the incoming message so that it can be consumed in the accept function
9217  }
9218 
9219  for (target_iterator _Iter = _M_connectedTargets.begin(); *_Iter != NULL; ++_Iter)
9220  {
9221  ITarget<size_t> * _PTarget = *_Iter;
9222  _PTarget->propagate(_M_pSendMessage, this);
9223  }
9224  }
single_link_registry< ITarget< size_t > >::iterator target_iterator
The iterator to walk the connected targets.
Definition: agents.h:3242
single_link_registry< ITarget< size_t > > _M_connectedTargets
Connected targets
Definition: agents.h:3833
::Concurrency::details::_ReentrantPPLLock _M_resetLock
Definition: agents.h:9239
#define NULL
Definition: crtdbg.h:30
message< _Type > * _M_pReceiveMessage
Definition: agents.h:8473
::Concurrency::details::_ReentrantPPLLock::_Scoped_lock _R_lock
A lock holder that acquires a reentrant lock on instantiation and releases it on destruction ...
Definition: agents.h:64
message< size_t > * _M_pSendMessage
Definition: agents.h:8476
void _Create_send_message()
Create a message that contains an index used to determine the source message
Definition: agents.h:8431
message< _Type > * _M_pGreedyMessage
Definition: agents.h:9233

Member Data Documentation

template<class _Type >
message<_Type>* Concurrency::_Greedy_node< _Type >::_M_pGreedyMessage
private
template<class _Type >
::Concurrency::details::_NonReentrantPPLLock Concurrency::_Greedy_node< _Type >::_M_propagationLock
private
template<class _Type >
::Concurrency::details::_ReentrantPPLLock Concurrency::_Greedy_node< _Type >::_M_resetLock
private
template<class _Type >
runtime_object_identity Concurrency::_Greedy_node< _Type >::_M_savedId
private

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