#include <scheduler.hpp>

Inheritance diagram for pion::multi_thread_scheduler:

Collaboration diagram for pion::multi_thread_scheduler:

Public Member Functions
	multi_thread_scheduler (void)
	constructs a new multi_thread_scheduler More...

virtual	~multi_thread_scheduler ()
	virtual destructor More...

Public Member Functions inherited from pion::scheduler
	scheduler (void)
	constructs a new scheduler More...

virtual	~scheduler ()
	virtual destructor More...

virtual void	startup (void)
	Starts the thread scheduler (this is called automatically when necessary) More...

virtual void	shutdown (void)
	Stops the thread scheduler (this is called automatically when the program exits) More...

void	join (void)
	the calling thread will sleep until the scheduler has stopped More...

void	add_active_user (void)

void	remove_active_user (void)
	unregisters an active user with the thread scheduler More...

bool	is_running (void) const
	returns true if the scheduler is running More...

void	set_num_threads (const boost::uint32_t n)
	sets the number of threads to be used (these are shared by all servers) More...

boost::uint32_t	get_num_threads (void) const
	returns the number of threads currently in use More...

void	set_logger (logger log_ptr)
	sets the logger to be used More...

logger	get_logger (void)
	returns the logger currently in use More...

virtual boost::asio::io_service &	get_io_service (void)=0
	returns an async I/O service used to schedule work More...

virtual void	post (boost::function0< void > work_func)

void	keep_running (boost::asio::io_service &my_service, boost::asio::deadline_timer &my_timer)

void	process_service_work (boost::asio::io_service &service)
	processes work passed to the asio service & handles uncaught exceptions More...

Protected Types
typedef std::vector < boost::shared_ptr < boost::thread > >	ThreadPool
	typedef for a pool of worker threads More...

Protected Member Functions
virtual void	stop_threads (void)
	stops all threads used to perform work More...

virtual void	finish_threads (void)
	finishes all threads used to perform work More...

Protected Member Functions inherited from pion::scheduler
virtual void	stop_services (void)
	stops all services used to schedule work More...

virtual void	finish_services (void)
	finishes all services used to schedule work More...

Protected Attributes
ThreadPool	m_thread_pool
	pool of threads used to perform work More...

Protected Attributes inherited from pion::scheduler
boost::mutex	m_mutex
	mutex to make class thread-safe More...

logger	m_logger
	primary logging interface used by this class More...

boost::condition	m_no_more_active_users
	condition triggered when there are no more active users More...

boost::condition	m_scheduler_has_stopped
	condition triggered when the scheduler has stopped More...

boost::uint32_t	m_num_threads
	total number of worker threads in the pool More...

boost::uint32_t	m_active_users
	the scheduler will not shutdown until there are no more active users More...

bool	m_is_running
	true if the thread scheduler is running More...

Additional Inherited Members
Static Public Member Functions inherited from pion::scheduler
static void	sleep (boost::uint32_t sleep_sec, boost::uint32_t sleep_nsec)

template<typename ConditionType , typename LockType >
static void	sleep (ConditionType &wakeup_condition, LockType &wakeup_lock, boost::uint32_t sleep_sec, boost::uint32_t sleep_nsec)

Static Protected Member Functions inherited from pion::scheduler
static boost::system_time	get_wakeup_time (boost::uint32_t sleep_sec, boost::uint32_t sleep_nsec)

Static Protected Attributes inherited from pion::scheduler
static const boost::uint32_t	DEFAULT_NUM_THREADS = 8
	default number of worker threads in the thread pool More...

static const boost::uint32_t	NSEC_IN_SECOND = 1000000000
	number of nanoseconds in one full second (10 ^ 9) More...

static const boost::uint32_t	MICROSEC_IN_SECOND = 1000000
	number of microseconds in one full second (10 ^ 6) More...

static const boost::uint32_t	KEEP_RUNNING_TIMER_SECONDS = 5
	number of seconds a timer should wait for to keep the IO services running More...

Detailed Description

multi_thread_scheduler: uses a pool of threads to perform work

Member Typedef Documentation

typedef std::vector<boost::shared_ptr<boost::thread> > pion::multi_thread_scheduler::ThreadPool

protected

typedef for a pool of worker threads

Constructor & Destructor Documentation

pion::multi_thread_scheduler::multi_thread_scheduler ( void )

inline

constructs a new multi_thread_scheduler

virtual pion::multi_thread_scheduler::~multi_thread_scheduler ( )

inlinevirtual

virtual destructor

Member Function Documentation

virtual void pion::multi_thread_scheduler::finish_threads ( void )

inlineprotectedvirtual

finishes all threads used to perform work

Reimplemented from pion::scheduler.

virtual void pion::multi_thread_scheduler::stop_threads ( void )

inlineprotectedvirtual

stops all threads used to perform work

Reimplemented from pion::scheduler.

References PION_LOG_DEBUG.

Member Data Documentation

ThreadPool pion::multi_thread_scheduler::m_thread_pool

protected

pool of threads used to perform work

Referenced by pion::single_service_scheduler::startup(), and pion::one_to_one_scheduler::startup().

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

include/pion/scheduler.hpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation