IOService Class Reference

Wrapper class for boost::asio::io_service. More...

#include <communication/IOService.h>

Public Member Functions
	IOService ()
	Creates an I/O service object that creates an own instance of BoostAsioIOObjectType. More...
	IOService (BoostAsioIOObjectType &service)
	Creates an I/O service object that uses an existing BoostAsioIOObjectType instance. More...
virtual	~IOService ()
	The destructor. More...
void	runThreads (std::size_t threadCount=0, bool runInThisThread=true)
	Starts a given number of threads on the BoostAsioIOObjectType::run() method. More...
std::size_t	run ()
	Wrapper for BoostAsioIOObjectType::run() This will block until BoostAsioIOObjectType::run() returns. More...
std::size_t	runOne ()
	Wrapper for BoostAsioIOObjectType::run_one() More...
void	stop ()
	Wrapper for BoostAsioIOObjectType::stop() More...
void	reset ()
	Wrapper for BoostAsioIOObjectType::reset() More...
	operator BoostAsioIOObjectType & ()
	Operator for implicit casting to BoostAsioIOObjectType. More...
template<typename CompletionHandler >
void	post (CompletionHandler handler)
void	join ()
	Stops and joins all started threads. More...

Detailed Description

Wrapper class for boost::asio::io_service.

Constructor & Destructor Documentation

IOService() [1/2]

IOService

(

)

Creates an I/O service object that creates an own instance of BoostAsioIOObjectType.

IOService() [2/2]

IOService

(

BoostAsioIOObjectType &

service

)

Creates an I/O service object that uses an existing BoostAsioIOObjectType instance.

~IOService()

virtual ~IOService ( )

inlinevirtual

The destructor.

Member Function Documentation

runThreads()

void runThreads	(	std::size_t	threadCount = 0,
		bool	runInThisThread = true
	)

Starts a given number of threads on the BoostAsioIOObjectType::run() method.

Parameters

[in]	threadCount	Number of threads to start.
[in]	runInThisThread	If true this method will call BoostAsioIOObjectType::run() and block until run() returns.

run()

std::size_t run ( )

inline

Wrapper for BoostAsioIOObjectType::run() This will block until BoostAsioIOObjectType::run() returns.

runOne()

std::size_t runOne ( )

inline

Wrapper for BoostAsioIOObjectType::run_one()

stop()

void stop ( )

inline

Wrapper for BoostAsioIOObjectType::stop()

reset()

void reset ( )

inline

Wrapper for BoostAsioIOObjectType::reset()

operator BoostAsioIOObjectType &()

operator BoostAsioIOObjectType & ( )

inline

Operator for implicit casting to BoostAsioIOObjectType.

post()

void post ( CompletionHandler  handler )

inline

join()

void join

(

)

Stops and joins all started threads.

---

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

• base/include/communication/IOService.h