Realistic 3D camera system
3D camera system components
Public Member Functions | List of all members
asio::io_service::work Class Reference

Class to inform the io_service when it has work to do. More...

#include <io_service.hpp>

Public Member Functions

 work (asio::io_service &io_service)
 Constructor notifies the io_service that work is starting. More...
 
 work (const work &other)
 Copy constructor notifies the io_service that work is starting. More...
 
 ~work ()
 Destructor notifies the io_service that the work is complete. More...
 
asio::io_serviceget_io_service ()
 Get the io_service associated with the work. More...
 

Detailed Description

Class to inform the io_service when it has work to do.

The work class is used to inform the io_service when work starts and finishes. This ensures that the io_service object's run() function will not exit while work is underway, and that it does exit when there is no unfinished work remaining.

The work class is copy-constructible so that it may be used as a data member in a handler class. It is not assignable.

Definition at line 626 of file io_service.hpp.

Constructor & Destructor Documentation

asio::io_service::work::work ( asio::io_service io_service)
inlineexplicit

Constructor notifies the io_service that work is starting.

The constructor is used to inform the io_service that some work has begun. This ensures that the io_service object's run() function will not exit while the work is underway.

Definition at line 121 of file io_service.hpp.

asio::io_service::work::work ( const work other)
inline

Copy constructor notifies the io_service that work is starting.

The constructor is used to inform the io_service that some work has begun. This ensures that the io_service object's run() function will not exit while the work is underway.

Definition at line 127 of file io_service.hpp.

asio::io_service::work::~work ( )
inline

Destructor notifies the io_service that the work is complete.

The destructor is used to inform the io_service that some work has finished. Once the count of unfinished work reaches zero, the io_service object's run() function is permitted to exit.

Definition at line 133 of file io_service.hpp.

Member Function Documentation

asio::io_service & asio::io_service::work::get_io_service ( )
inline

Get the io_service associated with the work.

Definition at line 138 of file io_service.hpp.


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