asio/src/doc/requirements/InternetProtocol.qbk

[/
 / 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:InternetProtocol Internet protocol requirements]

A type `X` meets the `InternetProtocol` requirements if it satisfies the
requirements of [link asio.reference.AcceptableProtocol `AcceptableProtocol`],
as well as the additional requirements listed below.

In the table below, `a` denotes a (possibly const) value of type `X`, and `b`
denotes a (possibly const) value of type `X`.

[table InternetProtocol requirements
  [[expression] [return type] [assertion/note\npre/post-conditions]]
  [
    [`X::resolver`]
    [`ip::basic_resolver<X>`]
    [The type of a resolver for the protocol.]
  ]
  [
    [`X::v4()`]
    [`X`]
    [Returns an object representing the IP version 4 protocol.]
  ]
  [
    [`X::v6()`]
    [`X`]
    [Returns an object representing the IP version 6 protocol.]
  ]
  [
    [`a == b`]
    [convertible to `bool`]
    [Returns `true` if `a` and `b` represent the same IP protocol version,
     otherwise `false`.]
  ]
  [
    [`a != b`]
    [convertible to `bool`]
    [Returns `!(a == b)`.]
  ]
]

[endsect]