Concurrency::details::_AnonymousOriginator< _Type > Class Template Reference

#include <agents.h>

Inheritance diagram for Concurrency::details::_AnonymousOriginator< _Type >:

Public Types
typedef single_link_registry< ITarget< _Type > >	_Target_registry
Public Types inherited from Concurrency::ISource< _Type >
typedef _Type	source_type
	A type alias for _Type . More...

Public Member Functions
	_AnonymousOriginator ()
virtual	~_AnonymousOriginator ()
virtual void	unlink_target (ITarget< _Type > *_PTarget)
virtual void	unlink_targets ()
	When overridden in a derived class, unlinks all target blocks from this ISource block. More...
virtual message< _Type > *	accept (runtime_object_identity _MsgId, ITarget< _Type > *_PTarget)
virtual bool	reserve (runtime_object_identity _MsgId, ITarget< _Type > *_PTarget)
virtual message< _Type > *	consume (runtime_object_identity _MsgId, ITarget< _Type > *_PTarget)
virtual void	release (runtime_object_identity _MsgId, ITarget< _Type > *_PTarget)
virtual void	acquire_ref (_Inout_ ITarget< _Type > *)
	When overridden in a derived class, acquires a reference count on this ISource block, to prevent deletion. More...
virtual void	release_ref (_Inout_ ITarget< _Type > *)
	When overridden in a derived class, releases a reference count on this ISource block. More...
Public Member Functions inherited from Concurrency::ISource< _Type >
virtual	~ISource ()
	Destroys the ISource object. More...
virtual void	link_target (_Inout_ ITarget< _Type > *_PTarget)=0
	When overridden in a derived class, links a target block to this ISource block. More...
virtual void	unlink_target (_Inout_ ITarget< _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< _Type > *	accept (runtime_object_identity _MsgId, _Inout_ ITarget< _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< _Type > *_PTarget)=0
	When overridden in a derived class, reserves a message previously offered by this ISource block. More...
virtual message< _Type > *	consume (runtime_object_identity _MsgId, _Inout_ ITarget< _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< _Type > *_PTarget)=0
	When overridden in a derived class, releases a previous successful message reservation. More...

Private Member Functions
bool	_internal_send (ITarget< _Type > *_PTarget, _Type const &_Value)
bool	_internal_asend (ITarget< _Type > *_PTarget, _Type const &_Value)
virtual void	link_target (ITarget< _Type > *_PTarget)

Private Attributes
message< _Type > *	_M_pMessage
ITarget< _Type > *	_M_pTarget

Friends
class	_Originator

Additional Inherited Members
Protected Member Functions inherited from Concurrency::ISource< _Type >
void	_Invoke_link_source (ITarget< _Type > *_PLinkFrom)
	Links this source to a target. More...
void	_Invoke_unlink_source (ITarget< _Type > *_PUnlinkFrom)
	Unlinks this source from a target. More...

Member Typedef Documentation

template<class _Type>

typedef single_link_registry<ITarget<_Type> > Concurrency::details::_AnonymousOriginator< _Type >::_Target_registry

Constructor & Destructor Documentation

template<class _Type>

Concurrency::details::_AnonymousOriginator< _Type >::_AnonymousOriginator ( )

inline

                               : _M_pMessage(NULL),  _M_pTarget(NULL)
        {
        }

template<class _Type>

virtual Concurrency::details::_AnonymousOriginator< _Type >::~_AnonymousOriginator ( )

inlinevirtual

        {
            delete _M_pMessage;
        }

Member Function Documentation

template<class _Type>

bool Concurrency::details::_AnonymousOriginator< _Type >::_internal_asend ( ITarget< _Type > *  _PTarget, _Type const &  _Value  )

inlineprivate

        {
            _M_pTarget = _PTarget;

            _CONCRT_ASSERT(_M_pTarget != NULL);
            _CONCRT_ASSERT(_M_pTarget->supports_anonymous_source());

            // Create the message
            message_status _Status = declined;
            message<_Type> * _Msg = new message<_Type>(_Value);

            _CONCRT_ASSERT(_M_pMessage == NULL);
            _M_pMessage = _Msg;

            // Send the message
            _Status = _M_pTarget->propagate(_M_pMessage, this);

            // If the message is declined, the destructor will
            // delete the message

            // status should not be postponed.
            if (_Status == postponed)
            {
                throw invalid_operation("Messages offered by _AnonymousOriginator shall not be postponed");
            }

            return (_Status == accepted);
        }

template<class _Type>

bool Concurrency::details::_AnonymousOriginator< _Type >::_internal_send ( ITarget< _Type > *  _PTarget, _Type const &  _Value  )

inlineprivate

        {
            _M_pTarget = _PTarget;

            _CONCRT_ASSERT(_M_pTarget != NULL);
            _CONCRT_ASSERT(_M_pTarget->supports_anonymous_source());

            // Create the message
            message_status _Status = declined;
            message<_Type> * _Msg = new message<_Type>(_Value);

            _CONCRT_ASSERT(_M_pMessage == NULL);
            _M_pMessage = _Msg;

            // Send the message
            _Status = _M_pTarget->send(_M_pMessage, this);

            // If the message is declined, the destructor will
            // delete the message

            // status should not be postponed.
            _CONCRT_ASSERT(_Status != postponed);
            return (_Status == accepted);
        }

template<class _Type>

virtual message<_Type>* Concurrency::details::_AnonymousOriginator< _Type >::accept ( runtime_object_identity  _MsgId, ITarget< _Type > *  _PTarget  )

inlinevirtual

        {
            if (_PTarget != _M_pTarget)
            {
                return NULL;
            }

            if (_M_pMessage == NULL || _M_pMessage->msg_id() != _MsgId)
            {
                return NULL;
            }

            // The IDs match, actaully transfer ownership of the message and
            // unlink away from the target
            message<_Type> * _Result = _M_pMessage;

            // The ownership of this message has changed.  Set the internal pointer to NULL
            // so it won't be deleted in the destructor
            _M_pMessage = NULL;

            return _Result;
        }

template<class _Type>

virtual void Concurrency::details::_AnonymousOriginator< _Type >::acquire_ref ( _Inout_ ITarget< _Type > *  _PTarget )

inlinevirtual

When overridden in a derived class, acquires a reference count on this ISource block, to prevent deletion.

Parameters

_PTarget

A pointer to the target block that is calling this method.

This method is called by an ITarget object that is being linked to this source during the link_target method.

Implements Concurrency::ISource< _Type >.

        {
            throw invalid_operation("acquire_ref is not supported on _AnonymousOriginator");
        }

template<class _Type>

virtual message<_Type>* Concurrency::details::_AnonymousOriginator< _Type >::consume ( runtime_object_identity  _MsgId, ITarget< _Type > *  _PTarget  )

inlinevirtual

        {
            throw invalid_operation("consume is not supported on _AnonymousOriginator");
        }

template<class _Type>

virtual void Concurrency::details::_AnonymousOriginator< _Type >::link_target ( ITarget< _Type > *  _PTarget )

inlineprivatevirtual

        {
            throw invalid_operation("link_target is not supported on _AnonymousOriginator");
        }

template<class _Type>

virtual void Concurrency::details::_AnonymousOriginator< _Type >::release ( runtime_object_identity  _MsgId, ITarget< _Type > *  _PTarget  )

inlinevirtual

        {
            throw invalid_operation("release is not supported on _AnonymousOriginator");
        }

template<class _Type>

virtual void Concurrency::details::_AnonymousOriginator< _Type >::release_ref ( _Inout_ ITarget< _Type > *  _PTarget )

inlinevirtual

When overridden in a derived class, releases a reference count on this ISource block.

Parameters

_PTarget

A pointer to the target block that is calling this method.

This method is called by an ITarget object that is being unlinked from this source. The source block is allowed to release any resources reserved for the target block.

Implements Concurrency::ISource< _Type >.

        {
            throw invalid_operation("release_ref is not supported on _AnonymousOriginator");
        }

template<class _Type>

virtual bool Concurrency::details::_AnonymousOriginator< _Type >::reserve ( runtime_object_identity  _MsgId, ITarget< _Type > *  _PTarget  )

inlinevirtual

        {
            throw invalid_operation("reserve is not supported on _AnonymousOriginator");
        }

template<class _Type>

virtual void Concurrency::details::_AnonymousOriginator< _Type >::unlink_target ( ITarget< _Type > *  _PTarget )

inlinevirtual

        {
            throw invalid_operation("unlink_target is not supported on _AnonymousOriginator");
        }

template<class _Type>

virtual void Concurrency::details::_AnonymousOriginator< _Type >::unlink_targets ( )

inlinevirtual

When overridden in a derived class, unlinks all target blocks from this ISource block.

Implements Concurrency::ISource< _Type >.

        {
            throw invalid_operation("unlink_targets is not supported on _AnonymousOriginator");
        }

Friends And Related Function Documentation

template<class _Type>

friend class _Originator

friend

Member Data Documentation

template<class _Type>

message<_Type>* Concurrency::details::_AnonymousOriginator< _Type >::_M_pMessage

private

template<class _Type>

ITarget<_Type>* Concurrency::details::_AnonymousOriginator< _Type >::_M_pTarget

private

---

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

• VS2013/inc/agents.h