Concurrency::source_link_manager< _LinkRegistry > Class Template Reference

The source_link_manager object manages messaging block network links to ISource blocks. More...

#include <agents.h>

Public Types
typedef _LinkRegistry	type
	The type of link registry being managed by the source_link_manager object. More...
typedef _LinkRegistry::type	_Block
	The type of the blocks being managed by the source_link_manager object. More...
typedef std::function< void(_Block *, bool)>	_Callback_method
	The method signature for a callback method for this source_link_manager object. More...
typedef _Block *	_EType
	A type that represents a pointer to an element stored in the source_link_manager object. More...
typedef _EType const &	const_reference
	A type that provides a reference to a const element stored in a source_link_manager object for reading and performing const operations. More...
typedef _EType const *	const_pointer
	A type that provides a pointer to a const element in a source_link_manager object. More...
typedef _Source_link_iterator< _LinkRegistry >	iterator
	A type that provides an iterator that can read or modify any element in the source_link_manager object. More...
typedef ::Concurrency::details::_ReentrantPPLLock	_LockType
	A type that provides a reentrant lock for the source_link_manager object. More...
typedef _LockType::_Scoped_lock	_LockHolder
	A type that provides a RAII scoped lock holder for a lock. More...

Public Member Functions
	source_link_manager ()
	Constructs a source_link_manager object. More...
	~source_link_manager ()
	Destroys the source_link_manager object. More...
void	register_target_block (_Inout_ ITarget< typename _Block::source_type > *_PTarget)
	Registers the target block that holds this source_link_manager object. More...
void	set_bound (size_t _MaxLinks)
	Sets the maximum number of source links that can be added to this source_link_manager object. More...
void	add (_EType _Link)
	Adds a source link to the source_link_manager object. More...
bool	remove (_EType _Link)
	Removes a link from the source_link_manager object. More...
void	reference ()
	Acquires a reference on the source_link_manager object. More...
void	release ()
	Releases the reference on the source_link_manager object. More...
bool	contains (_EType _Link)
	Searches the network_link_registry within this source_link_manager object for a specified block. More...
size_t	count ()
	Counts the number of linked blocks in the source_link_manager object. More...
iterator	begin ()
	Returns an iterator to the first element in the source_link_manager object. More...

Private Member Functions
void	_To_array (::Concurrency::details::_Dynamic_array< _EType > &_Array)

Private Attributes
_LockType	_M_lock
volatile long	_M_iteratorCount
::Concurrency::details::_Dynamic_array< _EType >	_M_pendingRemove
_LinkRegistry	_M_links
ITarget< typename _Block::source_type > *volatile	_M_pLinkedTarget

Friends
class	_Source_link_iterator< _LinkRegistry >

Detailed Description

template<class _LinkRegistry>
class Concurrency::source_link_manager< _LinkRegistry >

The source_link_manager object manages messaging block network links to ISource blocks.

Template Parameters

_LinkRegistry

The network link registry.

Currently, the source blocks are reference counted. This is a wrapper on a network_link_registry object that allows concurrent access to the links and provides the ability to reference the links through callbacks. Message blocks (target_blocks or propagator_blocks) should use this class for their source links.

See also

single_link_registry Class, multi_link_registry Class

Member Typedef Documentation

template<class _LinkRegistry>

typedef _LinkRegistry::type Concurrency::source_link_manager< _LinkRegistry >::_Block

The type of the blocks being managed by the source_link_manager object.

template<class _LinkRegistry>

typedef std::function<void(_Block *, bool)> Concurrency::source_link_manager< _LinkRegistry >::_Callback_method

The method signature for a callback method for this source_link_manager object.

template<class _LinkRegistry>

typedef _Block* Concurrency::source_link_manager< _LinkRegistry >::_EType

A type that represents a pointer to an element stored in the source_link_manager object.

template<class _LinkRegistry>

typedef _LockType::_Scoped_lock Concurrency::source_link_manager< _LinkRegistry >::_LockHolder

A type that provides a RAII scoped lock holder for a lock.

template<class _LinkRegistry>

typedef ::Concurrency::details::_ReentrantPPLLock Concurrency::source_link_manager< _LinkRegistry >::_LockType

A type that provides a reentrant lock for the source_link_manager object.

template<class _LinkRegistry>

typedef _EType const* Concurrency::source_link_manager< _LinkRegistry >::const_pointer

A type that provides a pointer to a const element in a source_link_manager object.

template<class _LinkRegistry>

typedef _EType const& Concurrency::source_link_manager< _LinkRegistry >::const_reference

A type that provides a reference to a const element stored in a source_link_manager object for reading and performing const operations.

template<class _LinkRegistry>

typedef _Source_link_iterator<_LinkRegistry> Concurrency::source_link_manager< _LinkRegistry >::iterator

A type that provides an iterator that can read or modify any element in the source_link_manager object.

template<class _LinkRegistry>

typedef _LinkRegistry Concurrency::source_link_manager< _LinkRegistry >::type

The type of link registry being managed by the source_link_manager object.

Constructor & Destructor Documentation

template<class _LinkRegistry>

Concurrency::source_link_manager< _LinkRegistry >::source_link_manager ( )

inline

Constructs a source_link_manager object.

                          : _M_iteratorCount(0), _M_pLinkedTarget(NULL)
    {
    }

template<class _LinkRegistry>

Concurrency::source_link_manager< _LinkRegistry >::~source_link_manager ( )

inline

Destroys the source_link_manager object.

    {
        _CONCRT_ASSERT(_M_pendingRemove._Size() == 0);
    }

Member Function Documentation

template<class _LinkRegistry>

void Concurrency::source_link_manager< _LinkRegistry >::_To_array ( ::Concurrency::details::_Dynamic_array< _EType > &  _Array )

inlineprivate

    {
        _LockHolder _Lock(_M_lock);
        _M_iteratorCount++;

        for(auto _Link = _M_links.begin(); *_Link != NULL; ++_Link)
        {
            _Array._Push_back(*_Link);
        }
    }

template<class _LinkRegistry>

void Concurrency::source_link_manager< _LinkRegistry >::add ( _EType  _Link )

inline

Adds a source link to the source_link_manager object.

Parameters

_Link

A pointer to a block to be added.

    {
        if (_Link == NULL)
        {
            return;
        }

        {
            _LockHolder _Lock(_M_lock);
            _M_links.add(_Link);

            // We need to add the _Link first and then invoke the
            // callback because _Add could throw.

            // As soon as the above lock is released, remove would
            // find the link that was added and could unlink it before
            // we are able to invoke the notification below. Keeping an
            // active iterator would prevent that from happening.
            _M_iteratorCount++;
        }

        // Acquire a reference on this link by the target
        _Link->acquire_ref(_M_pLinkedTarget);

        // Release the active iterator
        release();
    }

template<class _LinkRegistry>

iterator Concurrency::source_link_manager< _LinkRegistry >::begin ( )

inline

Returns an iterator to the first element in the source_link_manager object.

The end state of the iterator is indicated by a NULL link.

Returns

An iterator addressing the first element in the source_link_manager object.

    {
        return (iterator(this, 0));
    }

template<class _LinkRegistry>

bool Concurrency::source_link_manager< _LinkRegistry >::contains ( _EType  _Link )

inline

Searches the network_link_registry within this source_link_manager object for a specified block.

Parameters

_Link

A pointer to a block that is to be searched for in the source_link_manager object.

Returns

true if the specified block was found, false otherwise.

    {
        _LockHolder _Lock(_M_lock);
        return _M_links.contains(_Link);
    }

template<class _LinkRegistry>

size_t Concurrency::source_link_manager< _LinkRegistry >::count ( )

inline

Counts the number of linked blocks in the source_link_manager object.

Returns

The number of linked blocks in the source_link_manager object.

    {
        _LockHolder _Lock(_M_lock);
        return _M_links.count();
    }

template<class _LinkRegistry>

void Concurrency::source_link_manager< _LinkRegistry >::reference ( )

inline

Acquires a reference on the source_link_manager object.

    {
        _LockHolder _Lock(_M_lock);
        _M_iteratorCount++;
    }

template<class _LinkRegistry>

void Concurrency::source_link_manager< _LinkRegistry >::register_target_block ( _Inout_ ITarget< typename _Block::source_type > *  _PTarget )

inline

Registers the target block that holds this source_link_manager object.

Parameters

_PTarget

The target block holding this source_link_manager object.

    {
        _M_pLinkedTarget = _PTarget;
    }

template<class _LinkRegistry>

void Concurrency::source_link_manager< _LinkRegistry >::release ( )

inline

Releases the reference on the source_link_manager object.

    {
        ITarget<typename _Block::source_type> * _LinkedTarget = _M_pLinkedTarget;
        ::Concurrency::details::_Dynamic_array<_EType> _LinksToRemove;

        {
            _LockHolder _Lock(_M_lock);
            _CONCRT_ASSERT(_M_iteratorCount > 0);
            _M_iteratorCount--;

            if (_M_iteratorCount == 0)
            {
                if (_M_pendingRemove._Size() > 0)
                {
                    // Snap the pending remove list with the lock held
                    _M_pendingRemove._Swap(_LinksToRemove);
                }
            }
        }

        // NOTE: touching "this" pointer is dangerous as soon as the above lock is released

        // Release the references
        size_t _Size = _LinksToRemove._Size();

        for (size_t _I=0; _I < _Size; _I++)
        {
            _LinksToRemove[_I]->release_ref(_LinkedTarget);
        }
    }

template<class _LinkRegistry>

bool Concurrency::source_link_manager< _LinkRegistry >::remove ( _EType  _Link )

inline

Removes a link from the source_link_manager object.

Parameters

_Link

A pointer to a block to be removed, if found.

Returns

true if the link was found and removed, false otherwise.

    {
        bool _Removed = false;
        _EType _RemovedLink = NULL;
        ITarget<typename _Block::source_type> * _LinkedTarget = _M_pLinkedTarget;

        if (_Link == NULL)
        {
            return false;
        }

        {
             _LockHolder _Lock(_M_lock);
             _Removed = _M_links.remove(_Link);

             if (!_Removed)
             {
                 // No change was made
                 return _Removed;
             }

             if (_M_iteratorCount == 0)
             {
                 // Set the removed link to indicate that
                 // notification callback needs to be invoked.
                 _RemovedLink = _Link;
             }
             else
             {
                 // The iterator will complete the pending operation
                 _M_pendingRemove._Push_back(_Link);
             }
        }

        // NOTE: touching "this" pointer is dangerous as soon as the above lock is released

        // Release the reference for this link
        if (_RemovedLink != NULL)
        {
            _RemovedLink->release_ref(_LinkedTarget);
        }

         return _Removed;
    }

template<class _LinkRegistry>

void Concurrency::source_link_manager< _LinkRegistry >::set_bound ( size_t  _MaxLinks )

inline

Sets the maximum number of source links that can be added to this source_link_manager object.

Parameters

_MaxLinks

The maximum number of links.

    {
        _M_links.set_bound(_MaxLinks);
    }

Friends And Related Function Documentation

template<class _LinkRegistry>

friend class _Source_link_iterator< _LinkRegistry >

friend

Member Data Documentation

template<class _LinkRegistry>

volatile long Concurrency::source_link_manager< _LinkRegistry >::_M_iteratorCount

private

template<class _LinkRegistry>

_LinkRegistry Concurrency::source_link_manager< _LinkRegistry >::_M_links

private

template<class _LinkRegistry>

_LockType Concurrency::source_link_manager< _LinkRegistry >::_M_lock

private

template<class _LinkRegistry>

::Concurrency::details::_Dynamic_array<_EType> Concurrency::source_link_manager< _LinkRegistry >::_M_pendingRemove

private

template<class _LinkRegistry>

ITarget<typename _Block::source_type>* volatile Concurrency::source_link_manager< _LinkRegistry >::_M_pLinkedTarget

private

---

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

• VS2017/inc/agents.h