All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
asio::basic_io_object< IoObjectService > Class Template Reference

Base class for all I/O objects. More...

#include <basic_io_object.hpp>

Inheritance diagram for asio::basic_io_object< IoObjectService >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef
service_type::implementation_type 
implementation_type
 The underlying implementation type of I/O object.
typedef IoObjectService service_type
 The type of the service that will be used to provide I/O operations.

Public Member Functions

asio::io_serviceget_io_service ()
 Get the io_service associated with the object.
asio::io_serviceio_service ()

Protected Member Functions

 basic_io_object (asio::io_service &io_service)
 Construct a basic_io_object.
 ~basic_io_object ()
 Protected destructor to prevent deletion through this type.

Protected Attributes

implementation_type implementation
 The underlying implementation of the I/O object.
service_typeservice
 The service associated with the I/O object.

Detailed Description

template<typename IoObjectService>
class asio::basic_io_object< IoObjectService >

Base class for all I/O objects.

Definition at line 27 of file basic_io_object.hpp.


Member Typedef Documentation

template<typename IoObjectService>
typedef service_type::implementation_type asio::basic_io_object< IoObjectService >::implementation_type

The underlying implementation type of I/O object.

Definition at line 35 of file basic_io_object.hpp.

template<typename IoObjectService>
typedef IoObjectService asio::basic_io_object< IoObjectService >::service_type

The type of the service that will be used to provide I/O operations.

Definition at line 32 of file basic_io_object.hpp.


Constructor & Destructor Documentation

template<typename IoObjectService>
asio::basic_io_object< IoObjectService >::basic_io_object ( asio::io_service io_service) [inline, explicit, protected]

Construct a basic_io_object.

Performs:

 service.construct(implementation); 

Definition at line 70 of file basic_io_object.hpp.

template<typename IoObjectService>
asio::basic_io_object< IoObjectService >::~basic_io_object ( ) [inline, protected]

Protected destructor to prevent deletion through this type.

Performs:

Definition at line 81 of file basic_io_object.hpp.


Member Function Documentation

template<typename IoObjectService>
asio::io_service& asio::basic_io_object< IoObjectService >::get_io_service ( ) [inline]

Get the io_service associated with the object.

This function may be used to obtain the io_service object that the I/O object uses to dispatch handlers for asynchronous operations.

Returns:
A reference to the io_service object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.

Definition at line 59 of file basic_io_object.hpp.

template<typename IoObjectService>
asio::io_service& asio::basic_io_object< IoObjectService >::io_service ( ) [inline]

(Deprecated: use get_io_service().) Get the io_service associated with the object. This function may be used to obtain the io_service object that the I/O object uses to dispatch handlers for asynchronous operations.

Returns:
A reference to the io_service object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.

Definition at line 46 of file basic_io_object.hpp.


Member Data Documentation

template<typename IoObjectService>
implementation_type asio::basic_io_object< IoObjectService >::implementation [protected]

The underlying implementation of the I/O object.

Definition at line 90 of file basic_io_object.hpp.

template<typename IoObjectService>
service_type& asio::basic_io_object< IoObjectService >::service [protected]

The service associated with the I/O object.

Definition at line 87 of file basic_io_object.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:40