Concurrency::unbounded_buffer< _Type > Class Template Reference

An unbounded_buffer messaging block is a multi-target, multi-source, ordered propagator_block capable of storing an unbounded number of messages. More...

#include <agents.h>

Inheritance diagram for Concurrency::unbounded_buffer< _Type >:

Public Member Functions
	unbounded_buffer ()
	Constructs an unbounded_buffer messaging block. More...
	unbounded_buffer (filter_method const &_Filter)
	Constructs an unbounded_buffer messaging block. More...
	~unbounded_buffer ()
	Destroys the unbounded_buffer messaging block. More...
bool	enqueue (_Type const &_Item)
	Adds an item to the unbounded_buffer messaging block. More...
_Type	dequeue ()
	Removes an item from the unbounded_buffer messaging block. More...
Public Member Functions inherited from Concurrency::propagator_block< multi_link_registry< ITarget< _Type > >, 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< multi_link_registry< ITarget< _Type > >, _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< multi_link_registry< ITarget< _Type > >::type::type >
virtual	~ISource ()
	Destroys the ISource object. More...
virtual void	link_target (_Inout_ ITarget< multi_link_registry< ITarget< _Type > >::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< multi_link_registry< ITarget< _Type > >::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< multi_link_registry< ITarget< _Type > >::type::type > *	accept (runtime_object_identity _MsgId, _Inout_ ITarget< multi_link_registry< ITarget< _Type > >::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< multi_link_registry< ITarget< _Type > >::type::type > *_PTarget)=0
	When overridden in a derived class, reserves a message previously offered by this ISource block. More...
virtual message< multi_link_registry< ITarget< _Type > >::type::type > *	consume (runtime_object_identity _MsgId, _Inout_ ITarget< multi_link_registry< ITarget< _Type > >::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< multi_link_registry< ITarget< _Type > >::type::type > *_PTarget)=0
	When overridden in a derived class, releases a previous successful message reservation. More...
virtual void	acquire_ref (_Inout_ ITarget< multi_link_registry< ITarget< _Type > >::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< multi_link_registry< ITarget< _Type > >::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...

Protected Member Functions
virtual message_status	propagate_message (_Inout_ message< _Type > *_PMessage, _Inout_ ISource< _Type > *_PSource)
	Asynchronously passes a message from an ISource block to this unbounded_buffer messaging block. It is invoked by the propagate method, when called by a source block. More...
virtual message_status	send_message (_Inout_ message< _Type > *_PMessage, _Inout_ ISource< _Type > *_PSource)
	Synchronously passes a message from an ISource block to this unbounded_buffer messaging block. It is invoked by the send method, when called by a source block. More...
virtual bool	supports_anonymous_source ()
	Overrides the supports_anonymous_source method to indicate that this block can accept messages offered to it by a source that is not linked. More...
virtual message< _Type > *	accept_message (runtime_object_identity _MsgId)
	Accepts a message that was offered by this unbounded_buffer messaging block, transferring ownership to the caller. More...
virtual bool	reserve_message (runtime_object_identity _MsgId)
	Reserves a message previously offered by this unbounded_buffer messaging block. More...
virtual message< _Type > *	consume_message (runtime_object_identity _MsgId)
	Consumes a message previously offered by the unbounded_buffer messaging block and reserved by the target, transferring ownership to the caller. More...
virtual void	release_message (runtime_object_identity _MsgId)
	Releases a previous message reservation. More...
virtual void	resume_propagation ()
	Resumes propagation after a reservation has been released. More...
virtual void	link_target_notification (_Inout_ ITarget< _Type > *_PTarget)
	A callback that notifies that a new target has been linked to this unbounded_buffer messaging block. More...
virtual void	process_input_messages (_Inout_ message< _Type > *_PMessage)
	Places the message _PMessage in this unbounded_buffer messaging block and tries to offer it to all of the linked targets. More...
virtual void	propagate_output_messages ()
	Places the message _PMessage in this unbounded_buffer messaging block and tries to offer it to all of the linked targets. More...
Protected Member Functions inherited from Concurrency::propagator_block< multi_link_registry< ITarget< _Type > >, 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 > *)
	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< multi_link_registry< ITarget< _Type > >, _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_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< multi_link_registry< ITarget< _Type > >::type::type >
void	_Invoke_link_source (ITarget< multi_link_registry< ITarget< _Type > >::type::type > *_PLinkFrom)
	Links this source to a target. More...
void	_Invoke_unlink_source (ITarget< multi_link_registry< ITarget< _Type > >::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 Types
typedef multi_link_registry< ITarget< _Type > >	_TargetLinkRegistry
typedef multi_link_registry< ISource< _Type > >	_SourceLinkRegistry

Private Member Functions
void	_Propagate_priority_order (::Concurrency::details::_Queue< message< _Target_type >> &_MessageBuffer)
	Propagates messages in priority order. More...
void	_Delete_stored_messages ()
	Deletes all messages currently stored in this message block. Should be called by the destructor to ensure any messages propagated in are cleaned up. More...
unbounded_buffer const &	operator= (unbounded_buffer const &)
	unbounded_buffer (unbounded_buffer const &)

Private Attributes
::Concurrency::details::_Queue< message< _Type > >	_M_processedMessages
	Message queue used to store processed messages More...
::Concurrency::details::_Queue< message< _Type > >	_M_messageBuffer
	Message queue used to store messages More...
bool	_M_fForceRepropagation
	A bool to signal to the processor to force a repropagation to occur More...

Additional Inherited Members
Public Types inherited from Concurrency::propagator_block< multi_link_registry< ITarget< _Type > >, 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< multi_link_registry< ITarget< _Type > >, _MessageProcessorType >
typedef multi_link_registry< ITarget< _Type > >::type::type	_Target_type
	The payload type of messages handled by this source_block. More...
typedef multi_link_registry< ITarget< _Type > >::iterator	target_iterator
	The iterator to walk the connected targets. More...
Public Types inherited from Concurrency::ISource< multi_link_registry< ITarget< _Type > >::type::type >
typedef multi_link_registry< ITarget< _Type > >::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::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::propagator_block< multi_link_registry< ITarget< _Type > >, 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< multi_link_registry< ITarget< _Type > >, _MessageProcessorType >
ITarget< _Target_type > *	_M_pReservedFor
	Connected target that is holding a reservation More...
runtime_object_identity	_M_reservedId
	Reserved message ID More...
multi_link_registry< ITarget< _Type > >	_M_connectedTargets
	Connected targets More...
_MessageProcessorType	_M_messageProcessor
	Processor used for asynchronous message handling More...

Detailed Description

template<class _Type>
class Concurrency::unbounded_buffer< _Type >

An unbounded_buffer messaging block is a multi-target, multi-source, ordered propagator_block capable of storing an unbounded number of messages.

Template Parameters

_Type

The payload type of the messages stored and propagated by the buffer.

For more information, see Asynchronous Message Blocks.

See also

overwrite_buffer Class, single_assignment Class

Member Typedef Documentation

template<class _Type >

typedef multi_link_registry<ISource<_Type> > Concurrency::unbounded_buffer< _Type >::_SourceLinkRegistry

private

template<class _Type >

typedef multi_link_registry<ITarget<_Type> > Concurrency::unbounded_buffer< _Type >::_TargetLinkRegistry

private

Constructor & Destructor Documentation

template<class _Type >

Concurrency::unbounded_buffer< _Type >::unbounded_buffer ( )

inline

Constructs an unbounded_buffer messaging block.

The runtime uses the default scheduler if you do not specify the _PScheduler or _PScheduleGroup parameters.

The type filter_method is a functor with signature bool (_Type const &) which is invoked by this unbounded_buffer messaging block to determine whether or not it should accept an offered message.

See also

Scheduler Class, ScheduleGroup Class

                       :
      _M_fForceRepropagation(false)
    {
        this->initialize_source_and_target();
        this->enable_batched_processing();
    }

template<class _Type >

Concurrency::unbounded_buffer< _Type >::unbounded_buffer ( filter_method const &  _Filter )

inline

Constructs an unbounded_buffer messaging block.

Parameters

_Filter

A filter function which determines whether offered messages should be accepted.

The runtime uses the default scheduler if you do not specify the _PScheduler or _PScheduleGroup parameters.

The type filter_method is a functor with signature bool (_Type const &) which is invoked by this unbounded_buffer messaging block to determine whether or not it should accept an offered message.

See also

Scheduler Class, ScheduleGroup Class

                                                   :
      _M_fForceRepropagation(false)
    {
        this->initialize_source_and_target();
        this->enable_batched_processing();
        this->register_filter(_Filter);
    }

template<class _Type >

Concurrency::unbounded_buffer< _Type >::~unbounded_buffer ( )

inline

Destroys the unbounded_buffer messaging block.

    {
        // Remove all links
        this->remove_network_links();

        // Clean up any messages left in this message block
        _Delete_stored_messages();
    }

template<class _Type >

Concurrency::unbounded_buffer< _Type >::unbounded_buffer ( unbounded_buffer< _Type > const &  )

private

Member Function Documentation

template<class _Type >

void Concurrency::unbounded_buffer< _Type >::_Delete_stored_messages ( )

inlineprivate

Deletes all messages currently stored in this message block. Should be called by the destructor to ensure any messages propagated in are cleaned up.

    {
        // Input messages for this message block are in the base-class input buffer
        // All messages in that buffer are guaranteed to have moved to the output
        // buffer because the destructor first waits for all async sends to finish
        // before reaching this point

        // Delete any messages remaining in the output queue
        for (;;)
        {
            message<_Type> * _Msg = _M_messageBuffer._Dequeue();
            if (_Msg == NULL)
            {
                break;
            }
            delete _Msg;
        }
    }

template<class _Type >

void Concurrency::unbounded_buffer< _Type >::_Propagate_priority_order ( ::Concurrency::details::_Queue< message< _Target_type >> &  _MessageBuffer )

inlineprivate

Propagates messages in priority order.

Parameters

_MessageBuffer

Reference to a message queue with messages to be propagated

    {
        message<_Target_type> * _Msg = _MessageBuffer._Peek();

        // If someone has reserved the _Head message, don't propagate anymore
        if (this->_M_pReservedFor != NULL)
        {
            return;
        }

        while (_Msg != NULL)
        {
            message_status _Status = declined;

            // Always start from the first target that linked
            for (target_iterator _Iter = this->_M_connectedTargets.begin(); *_Iter != NULL; ++_Iter)
            {
                ITarget<_Target_type> * _PTarget = *_Iter;
                _Status = _PTarget->propagate(_Msg, this);

                // Ownership of message changed. Do not propagate this
                // message to any other target.
                if (_Status == accepted)
                {
                    break;
                }

                // If the target just propagated to reserved this message, stop
                // propagating it to others
                if (this->_M_pReservedFor != NULL)
                {
                    break;
                }
            }

            // If status is anything other than accepted, then the head message
            // was not propagated out.  Thus, nothing after it in the queue can
            // be propagated out.  Cease propagation.
            if (_Status != accepted)
            {
                break;
            }

            // Get the next message
            _Msg = _MessageBuffer._Peek();
        }
    }

template<class _Type >

virtual message<_Type>* Concurrency::unbounded_buffer< _Type >::accept_message ( runtime_object_identity  _MsgId )

inlineprotectedvirtual

Accepts a message that was offered by this unbounded_buffer messaging block, transferring ownership to the caller.

Parameters

_MsgId

The runtime_object_identity of the offered message object.

Returns

A pointer to the message object that the caller now has ownership of.

Implements Concurrency::source_block< multi_link_registry< ITarget< _Type > >, _MessageProcessorType >.

    {
        //
        // Peek at the head message in the message buffer.  If the IDs match
        // dequeue and transfer ownership
        //
        message<_Type> * _Msg = NULL;

        if (_M_messageBuffer._Is_head(_MsgId))
        {
            _Msg = _M_messageBuffer._Dequeue();
        }

        return _Msg;
    }

template<class _Type >

virtual message<_Type>* Concurrency::unbounded_buffer< _Type >::consume_message ( runtime_object_identity  _MsgId )

inlineprotectedvirtual

Consumes a message previously offered by the unbounded_buffer messaging block and reserved by the target, transferring ownership to the caller.

Parameters

_MsgId

The runtime_object_identity of the message object being consumed.

Returns

A pointer to the message object that the caller now has ownership of.

Similar to accept, but is always preceded by a call to reserve.

Implements Concurrency::source_block< multi_link_registry< ITarget< _Type > >, _MessageProcessorType >.

    {
        // By default, accept the message
        return accept_message(_MsgId);
    }

template<class _Type >

_Type Concurrency::unbounded_buffer< _Type >::dequeue ( )

inline

Removes an item from the unbounded_buffer messaging block.

Returns

The payload of the message removed from the unbounded_buffer.

    {
        return ::Concurrency::receive<_Type>(this);
    }

template<class _Type >

bool Concurrency::unbounded_buffer< _Type >::enqueue ( _Type const &  _Item )

inline

Adds an item to the unbounded_buffer messaging block.

Parameters

_Item

The item to add.

Returns

true if the item was accepted, false otherwise.

    {
        return ::Concurrency::send<_Type>(this, _Item);
    }

template<class _Type >

virtual void Concurrency::unbounded_buffer< _Type >::link_target_notification ( _Inout_ ITarget< _Type > *  _PTarget )

inlineprotectedvirtual

A callback that notifies that a new target has been linked to this unbounded_buffer messaging block.

Parameters

_PTarget

A pointer to the newly linked target.

    {
        // If the message queue is blocked due to reservation
        // there is no need to do any message propagation
        if (this->_M_pReservedFor != NULL)
        {
            return;
        }

        message<_Type> * _Msg = _M_messageBuffer._Peek();

        if (_Msg != NULL)
        {
            // Propagate the head message to the new target
            message_status _Status = _PTarget->propagate(_Msg, this);

            if (_Status == accepted)
            {
                // The target accepted the message, restart propagation.
                _Propagate_priority_order(_M_messageBuffer);
            }

            // If the status is anything other than accepted, then leave
            // the message queue blocked.
        }
    }

template<class _Type >

unbounded_buffer const& Concurrency::unbounded_buffer< _Type >::operator= ( unbounded_buffer< _Type > const &  )

private

template<class _Type >

virtual void Concurrency::unbounded_buffer< _Type >::process_input_messages ( _Inout_ message< _Type > *  _PMessage )

inlineprotectedvirtual

Places the message _PMessage in this unbounded_buffer messaging block and tries to offer it to all of the linked targets.

    {
        if (_PMessage != NULL)
        {
            _M_processedMessages._Enqueue(_PMessage);
        }
    }

template<class _Type >

virtual message_status Concurrency::unbounded_buffer< _Type >::propagate_message ( _Inout_ message< _Type > *  _PMessage, _Inout_ ISource< _Type > *  _PSource  )

inlineprotectedvirtual

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

Parameters

_PMessage	A pointer to the message object.
_PSource	A 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 <c>consume</c> and the LWT.  Doing so could
        // result in a deadlock.

        message_status _Result = accepted;

        // Accept the message being propagated
        _PMessage = _PSource->accept(_PMessage->msg_id(), this);

        if (_PMessage != NULL)
        {
            this->async_send(_PMessage);
        }
        else
        {
            _Result = missed;
        }

        return _Result;
    }

template<class _Type >

virtual void Concurrency::unbounded_buffer< _Type >::propagate_output_messages ( )

inlineprotectedvirtual

Places the message _PMessage in this unbounded_buffer messaging block and tries to offer it to all of the linked targets.

Parameters

_PMessage

A pointer to a message object that this unbounded_buffer has taken ownership of.

If another message is already ahead of this one in the unbounded_buffer, propagation to linked targets will not occur until any earlier messages have been accepted or consumed. The first linked target to successfully accept or consume the message takes ownership, and no other target can then get the message.

Reimplemented from Concurrency::source_block< multi_link_registry< ITarget< _Type > >, _MessageProcessorType >.

    {
        // Move the messages from the processedMessages queue to the internal storage
        // to make them ready for propagating out

        // If there are messages in the message queue, the queue is blocked and a
        // propagation should not happen unless it has been forced using resume_propagation
        bool _FIsBlocked = (_M_messageBuffer._Count() > 0);

        for(;;)
        {
            message<_Type> * _PInputMessage = _M_processedMessages._Dequeue();
            if(_PInputMessage == NULL)
            {
                break;
            }
            _M_messageBuffer._Enqueue(_PInputMessage);
        }

        if (_M_fForceRepropagation == false && _FIsBlocked == true)
        {
            return;
        }

        // Reset the repropagation flag because a propagation has started.
        _M_fForceRepropagation = false;

        // Attempt to propagate messages to all the targets
        _Propagate_priority_order(_M_messageBuffer);
    }

template<class _Type >

virtual void Concurrency::unbounded_buffer< _Type >::release_message ( runtime_object_identity  _MsgId )

inlineprotectedvirtual

Releases a previous message reservation.

Parameters

_MsgId

The runtime_object_identity of the message object being released.

Implements Concurrency::source_block< multi_link_registry< ITarget< _Type > >, _MessageProcessorType >.

    {
        // The head message is the one reserved.
        if (!_M_messageBuffer._Is_head(_MsgId))
        {
            throw message_not_found();
        }
    }

template<class _Type >

virtual bool Concurrency::unbounded_buffer< _Type >::reserve_message ( runtime_object_identity  _MsgId )

inlineprotectedvirtual

Reserves a message previously offered by this unbounded_buffer messaging block.

Parameters

_MsgId

The runtime_object_identity of the message object being reserved.

Returns

true if the message was successfully reserved, false otherwise.

After reserve is called, if it returns true, either consume or release must be called to either take or release ownership of the message.

Implements Concurrency::source_block< multi_link_registry< ITarget< _Type > >, _MessageProcessorType >.

    {
        // Allow reservation if this is the head message
        return _M_messageBuffer._Is_head(_MsgId);
    }

template<class _Type >

virtual void Concurrency::unbounded_buffer< _Type >::resume_propagation ( )

inlineprotectedvirtual

Resumes propagation after a reservation has been released.

Implements Concurrency::source_block< multi_link_registry< ITarget< _Type > >, _MessageProcessorType >.

    {
        // If there are any messages in the buffer, propagate them out
        if (_M_messageBuffer._Count() > 0)
        {
            // Set the flag to force a repropagation. This flag is cleared when a propagation happens
            // The only functions that call this are release, consume, and link_target, all of which
            // hold the internal lock, so the flag is guaranteed to be read by propagation, which also
            // holds the same lock.
            _M_fForceRepropagation = true;

            // async send a NULL value to initiate the repropagation
            this->async_send(NULL);
        }
    }

template<class _Type >

virtual message_status Concurrency::unbounded_buffer< _Type >::send_message ( _Inout_ message< _Type > *  _PMessage, _Inout_ ISource< _Type > *  _PSource  )

inlineprotectedvirtual

Synchronously passes a message from an ISource block to this unbounded_buffer messaging block. It is invoked by the send method, when called by a source block.

Parameters

_PMessage	A pointer to the message object.
_PSource	A pointer to the source block offering the message.

Returns

A message_status indication of what the target decided to do with the message.

    {
        _PMessage = _PSource->accept(_PMessage->msg_id(), this);

        if (_PMessage != NULL)
        {
            this->sync_send(_PMessage);
        }
        else
        {
            return missed;
        }

        return accepted;
    }

template<class _Type >

virtual bool Concurrency::unbounded_buffer< _Type >::supports_anonymous_source ( )

inlineprotectedvirtual

Overrides the supports_anonymous_source method to indicate that this block can accept messages offered to it by a source that is not linked.

Returns

true because the block does not postpone offered messages.

Reimplemented from Concurrency::ITarget< multi_link_registry< ISource< _Type > >::type::source_type >.

    {
        return true;
    }

Member Data Documentation

template<class _Type >

bool Concurrency::unbounded_buffer< _Type >::_M_fForceRepropagation

private

A bool to signal to the processor to force a repropagation to occur

template<class _Type >

::Concurrency::details::_Queue<message<_Type> > Concurrency::unbounded_buffer< _Type >::_M_messageBuffer

private

Message queue used to store messages

template<class _Type >

::Concurrency::details::_Queue<message<_Type> > Concurrency::unbounded_buffer< _Type >::_M_processedMessages

private

Message queue used to store processed messages

---

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

• VS2017/inc/agents.h