summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/asio/src/doc/requirements/IoControlCommand.qbk
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/asio/src/doc/requirements/IoControlCommand.qbk')
-rw-r--r--3rdparty/asio/src/doc/requirements/IoControlCommand.qbk34
1 files changed, 34 insertions, 0 deletions
diff --git a/3rdparty/asio/src/doc/requirements/IoControlCommand.qbk b/3rdparty/asio/src/doc/requirements/IoControlCommand.qbk
new file mode 100644
index 00000000000..8809335a4ee
--- /dev/null
+++ b/3rdparty/asio/src/doc/requirements/IoControlCommand.qbk
@@ -0,0 +1,34 @@
+[/
+ / 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:IoControlCommand I/O control command requirements]
+
+A type `X` meets the `IoControlCommand` requirements if it satisfies the
+requirements listed below.
+
+In the table below, `a` denotes a (possibly const) value of type `X`, and `b`
+denotes a value of type `X`.
+
+[table IoControlCommand requirements for extensible implementations
+ [[expression] [type] [assertion/note\npre/post-conditions]]
+ [
+ [`a.name()`]
+ [`int`]
+ [
+ Returns a value suitable for passing as the /request/ argument to
+ __POSIX__ __ioctl__ (or equivalent).
+ ]
+ ]
+ [
+ [`b.data()`]
+ [`void*`]
+ [
+ ]
+ ]
+]
+
+[endsect]