[ceph.git] / ceph / src / boost / libs / asio / 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]

An internet protocol must meet the requirements for a [link
boost_asio.reference.Protocol protocol] as well as the additional
requirements listed below.

In the table below, `X` denotes an internet protocol class, `a` denotes a value
of type `X`, and `b` denotes a 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 whether two protocol objects are equal.]
  ]
  [
    [`a != b`]
    [convertible to `bool`]
    [Returns `!(a == b)`.]
  ]
]

[endsect]
Commit	Line	Data
7c673cae FG	1	[/
	2	/ Copyright (c) 2003-2016 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
	8	[section:InternetProtocol Internet protocol requirements]
	9
	10	An internet protocol must meet the requirements for a [link
	11	boost_asio.reference.Protocol protocol] as well as the additional
	12	requirements listed below.
	13
	14	In the table below, `X` denotes an internet protocol class, `a` denotes a value
	15	of type `X`, and `b` denotes a value of type `X`.
	16
	17	[table InternetProtocol requirements
	18	[[expression] [return type] [assertion/note\npre/post-conditions]]
	19	[
	20	[`X::resolver`]
	21	[`ip::basic_resolver<X>`]
	22	[The type of a resolver for the protocol.]
	23	]
	24	[
	25	[`X::v4()`]
	26	[`X`]
	27	[Returns an object representing the IP version 4 protocol.]
	28	]
	29	[
	30	[`X::v6()`]
	31	[`X`]
	32	[Returns an object representing the IP version 6 protocol.]
	33	]
	34	[
	35	[`a == b`]
	36	[convertible to `bool`]
	37	[Returns whether two protocol objects are equal.]
	38	]
	39	[
	40	[`a != b`]
	41	[convertible to `bool`]
	42	[Returns `!(a == b)`.]
	43	]
	44	]
	45
	46	[endsect]