[ceph.git] / ceph / src / boost / libs / asio / doc / requirements / Service.qbk

[/
 / Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com)
 /
 / Distributed under the Boost Software License, Version 1.0. (See accompanying
 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 /]

[section:Service Service requirements]

A class is a service if it is publicly derived from another service, or if it
is a class derived from `io_service::service` and contains a
publicly-accessible declaration as follows:

  static io_service::id id;

All services define a one-argument constructor that takes a reference to the
`io_service` object that owns the service. This constructor is /explicit/,
preventing its participation in automatic conversions. For example:

  class my_service : public io_service::service
  {
  public:
    static io_service::id id;
    explicit my_service(io_service& ios);
  private:
    virtual void shutdown_service();
    ...
  };

A service's `shutdown_service` member function must cause all copies of
user-defined handler objects that are held by the service to be destroyed.

[endsect]
Commit	Line	Data
7c673cae FG	1	[/
	2	/ Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com)
	3	/
	4	/ Distributed under the Boost Software License, Version 1.0. (See accompanying
	5	/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
	6	/]
	7
	8	[section:Service Service requirements]
	9
	10	A class is a service if it is publicly derived from another service, or if it
	11	is a class derived from `io_service::service` and contains a
	12	publicly-accessible declaration as follows:
	13
	14	static io_service::id id;
	15
	16	All services define a one-argument constructor that takes a reference to the
	17	`io_service` object that owns the service. This constructor is /explicit/,
	18	preventing its participation in automatic conversions. For example:
	19
	20	class my_service : public io_service::service
	21	{
	22	public:
	23	static io_service::id id;
	24	explicit my_service(io_service& ios);
	25	private:
	26	virtual void shutdown_service();
	27	...
	28	};
	29
	30	A service's `shutdown_service` member function must cause all copies of
	31	user-defined handler objects that are held by the service to be destroyed.
	32
	33	[endsect]