Concurrency::scheduler_ptr Struct Reference

Represents a pointer to a scheduler. This class exists to allow the the specification of a shared lifetime by using shared_ptr or just a plain reference by using raw pointer. More...

#include <pplinterface.h>

Public Member Functions
	scheduler_ptr (std::shared_ptr< scheduler_interface > scheduler)
	Creates a scheduler pointer from shared_ptr to scheduler More...
	scheduler_ptr (_In_opt_ scheduler_interface *pScheduler)
	Creates a scheduler pointer from raw pointer to scheduler More...
scheduler_interface *	operator-> () const
	Behave like a pointer More...
scheduler_interface *	get () const
	Returns the raw pointer to the scheduler More...
	operator bool () const
	Test whether the scheduler pointer is non-null More...

Private Attributes
std::shared_ptr< scheduler_interface >	m_sharedScheduler
scheduler_interface *	m_scheduler

Detailed Description

Represents a pointer to a scheduler. This class exists to allow the the specification of a shared lifetime by using shared_ptr or just a plain reference by using raw pointer.

Constructor & Destructor Documentation

Concurrency::scheduler_ptr::scheduler_ptr ( std::shared_ptr< scheduler_interface >  scheduler )

inlineexplicit

Creates a scheduler pointer from shared_ptr to scheduler

                                                                         : m_sharedScheduler(std::move(scheduler))
    {
        m_scheduler = m_sharedScheduler.get();
    }

Concurrency::scheduler_ptr::scheduler_ptr ( _In_opt_ scheduler_interface *  pScheduler )

inlineexplicit

Creates a scheduler pointer from raw pointer to scheduler

                                                                      : m_scheduler(pScheduler)
    {
    }

Member Function Documentation

scheduler_interface* Concurrency::scheduler_ptr::get ( ) const

inline

Returns the raw pointer to the scheduler

    {
        return m_scheduler;
    }

Concurrency::scheduler_ptr::operator bool ( ) const

inline

Test whether the scheduler pointer is non-null

{ return get() != nullptr; }

scheduler_interface* Concurrency::scheduler_ptr::operator-> ( ) const

inline

Behave like a pointer

    {
        return get();
    }

Member Data Documentation

scheduler_interface* Concurrency::scheduler_ptr::m_scheduler

private

std::shared_ptr<scheduler_interface> Concurrency::scheduler_ptr::m_sharedScheduler

private

---

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

• VS2013/inc/pplinterface.h