All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Member Functions | Private Attributes
asio::io_service::work Class Reference

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

#include <io_service.hpp>

List of all members.

Public Member Functions

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

Private Member Functions

void operator= (const work &other)

Private Attributes

asio::io_serviceio_service_

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'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 438 of file io_service.hpp.


Constructor & Destructor Documentation

asio::io_service::work::work ( asio::io_service io_service) [explicit]

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's run() function will not exit while the work is underway.

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

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's run() function will not exit while the work is underway.

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's run() function is permitted to exit.


Member Function Documentation

Get the io_service associated with the work.

(Deprecated: use get_io_service().) Get the io_service associated with the work.

void asio::io_service::work::operator= ( const work other) [private]

Member Data Documentation

Definition at line 477 of file io_service.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Castor
Author(s): Carpe Noctem
autogenerated on Fri Nov 8 2013 11:05:41