mirror of
https://github.com/boostorg/asio.git
synced 2026-02-02 20:32:08 +00:00
121 lines
2.7 KiB
Plaintext
121 lines
2.7 KiB
Plaintext
[/
|
|
/ Copyright (c) 2003-2008 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:DescriptorService Descriptor service requirements]
|
|
|
|
A descriptor service must meet the requirements for an [link
|
|
boost_asio.reference.IoObjectService I/O object service], as well as the
|
|
additional requirements listed below.
|
|
|
|
In the table below, `X` denotes a descriptor service class, `a` denotes a value
|
|
of type `X`, `b` denotes a value of type `X::implementation_type`, `n` denotes
|
|
a value of type `X::native_type`, `ec` denotes a value of type `error_code`,
|
|
`i` denotes a value meeting [link boost_asio.reference.IoControlCommand
|
|
`IoControlCommand`] requirements, and `u` and `v` denote identifiers.
|
|
|
|
[table DescriptorService requirements
|
|
[[expression] [return type] [assertion/note\npre/post-condition]]
|
|
[
|
|
[`X::native_type`]
|
|
[]
|
|
[
|
|
The implementation-defined native representation of a descriptor. Must
|
|
satisfy the requirements of `CopyConstructible` types (C++ Std, 20.1.3),
|
|
and the requirements of `Assignable` types (C++ Std, 23.1).
|
|
]
|
|
]
|
|
[
|
|
[`a.construct(b);`]
|
|
[]
|
|
[
|
|
From [link boost_asio.reference.IoObjectService IoObjectService]
|
|
requirements.\n
|
|
post: `!a.is_open(b)`.
|
|
]
|
|
]
|
|
[
|
|
[`a.destroy(b);`]
|
|
[]
|
|
[
|
|
From [link boost_asio.reference.IoObjectService IoObjectService]
|
|
requirements. Implicitly cancels asynchronous operations, as if by calling
|
|
`a.close(b, ec)`.
|
|
]
|
|
]
|
|
[
|
|
[``
|
|
a.assign(b, n, ec);
|
|
``]
|
|
[`error_code`]
|
|
[
|
|
pre: `!a.is_open(b)`.\n
|
|
post: `!!ec || a.is_open(b)`.
|
|
]
|
|
]
|
|
[
|
|
[``
|
|
a.is_open(b);
|
|
``]
|
|
[`bool`]
|
|
[
|
|
]
|
|
]
|
|
[
|
|
[``
|
|
const X& u = a;
|
|
const X::implementation_type& v = b;
|
|
u.is_open(v);
|
|
``]
|
|
[`bool`]
|
|
[
|
|
]
|
|
]
|
|
[
|
|
[``
|
|
a.close(b, ec);
|
|
``]
|
|
[`error_code`]
|
|
[
|
|
If `a.is_open()` is true, causes any outstanding asynchronous operations
|
|
to complete as soon as possible. Handlers for cancelled operations shall
|
|
be passed the error code `error::operation_aborted`.\n
|
|
post: `!a.is_open(b)`.
|
|
]
|
|
]
|
|
[
|
|
[``
|
|
a.native(b);
|
|
``]
|
|
[`X::native_type`]
|
|
[
|
|
]
|
|
]
|
|
[
|
|
[``
|
|
a.cancel(b, ec);
|
|
``]
|
|
[`error_code`]
|
|
[
|
|
pre: `a.is_open(b)`.\n
|
|
Causes any outstanding asynchronous operations to complete as soon as
|
|
possible. Handlers for cancelled operations shall be passed the error
|
|
code `error::operation_aborted`.
|
|
]
|
|
]
|
|
[
|
|
[``
|
|
a.io_control(b, i, ec);
|
|
``]
|
|
[`error_code`]
|
|
[
|
|
pre: `a.is_open(b)`.
|
|
]
|
|
]
|
|
]
|
|
|
|
[endsect]
|