InternetProtocol.qbk 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. [/
  2. / Copyright (c) 2003-2019 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. [section:InternetProtocol Internet protocol requirements]
  8. A type `X` meets the `InternetProtocol` requirements if it satisfies the
  9. requirements of [link boost_asio.reference.AcceptableProtocol `AcceptableProtocol`],
  10. as well as the additional requirements listed below.
  11. In the table below, `a` denotes a (possibly const) value of type `X`, and `b`
  12. denotes a (possibly const) value of type `X`.
  13. [table InternetProtocol requirements
  14. [[expression] [return type] [assertion/note\npre/post-conditions]]
  15. [
  16. [`X::resolver`]
  17. [`ip::basic_resolver<X>`]
  18. [The type of a resolver for the protocol.]
  19. ]
  20. [
  21. [`X::v4()`]
  22. [`X`]
  23. [Returns an object representing the IP version 4 protocol.]
  24. ]
  25. [
  26. [`X::v6()`]
  27. [`X`]
  28. [Returns an object representing the IP version 6 protocol.]
  29. ]
  30. [
  31. [`a == b`]
  32. [convertible to `bool`]
  33. [Returns `true` if `a` and `b` represent the same IP protocol version,
  34. otherwise `false`.]
  35. ]
  36. [
  37. [`a != b`]
  38. [convertible to `bool`]
  39. [Returns `!(a == b)`.]
  40. ]
  41. ]
  42. [endsect]