summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/asio/src/doc/requirements/IoControlCommand.qbk
blob: 8809335a4ee98722e89e259e765445431140852f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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]