diff options
Diffstat (limited to '3rdparty/asio/src/doc/requirements/Protocol.qbk')
-rw-r--r-- | 3rdparty/asio/src/doc/requirements/Protocol.qbk | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/3rdparty/asio/src/doc/requirements/Protocol.qbk b/3rdparty/asio/src/doc/requirements/Protocol.qbk new file mode 100644 index 00000000000..7a55d147fc1 --- /dev/null +++ b/3rdparty/asio/src/doc/requirements/Protocol.qbk @@ -0,0 +1,54 @@ +[/ + / 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:Protocol Protocol requirements] + +A type `X` meets the `Protocol` requirements if it satisfies the requirements +of `Destructible` (C++Std [destructible]), `CopyConstructible` (C++Std +[copyconstructible]), and `CopyAssignable` (C++Std [copyassignable]), as well +as the additional requirements listed below. + +[table Protocol requirements + [[expression] [return type] [assertion/note\npre/post-conditions]] + [ + [`X::endpoint`] + [type meeting [link asio.reference.Endpoint endpoint] requirements] + [] + ] +] + +In the table below, `a` denotes a (possibly const) value of type `X`. + +[table Protocol requirements for extensible implementations + [[expression] [return type] [assertion/note\npre/post-conditions]] + [ + [`a.family()`] + [`int`] + [ + Returns a value suitable for passing as the /domain/ argument to + __POSIX__ __socket__ (or equivalent). + ] + ] + [ + [`a.type()`] + [`int`] + [ + Returns a value suitable for passing as the /type/ argument to __POSIX__ + __socket__ (or equivalent). + ] + ] + [ + [`a.protocol()`] + [`int`] + [ + Returns a value suitable for passing as the /protocol/ argument to + __POSIX__ __socket__ (or equivalent). + ] + ] +] + +[endsect] |