• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/
2 / Copyright (c) 2003-2021 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[library Boost.Asio
9    [quickbook 1.4]
10    [copyright 2003 - 2021 Christopher M. Kohlhoff]
11    [purpose Networking library]
12    [license
13        Distributed under the Boost Software License, Version 1.0.
14        (See accompanying file LICENSE_1_0.txt or copy at
15        [@http://www.boost.org/LICENSE_1_0.txt])
16    ]
17    [authors [Kohlhoff, Christopher]]
18    [category template]
19    [category generic]
20]
21
22[template mdash[] '''— ''']
23[template hr[] [br]'''<phrase role="silver">'''[mdash]'''</phrase>'''[br]]
24[template half_open_range[text] '''&#91;'''[text])]
25[template indexterm1[id term1] '''<indexterm id="'''[id]'''"><primary>'''[term1]'''</primary></indexterm>''']
26[template indexterm2[id term1 term2] '''<indexterm id="'''[id]'''"><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
27[template inline_note[text] \[['Note:] [text] '''&mdash;'''['end note]\] ]
28[template ticket[number]'''<ulink url="https://svn.boost.org/trac/boost/ticket/'''[number]'''">'''#[number]'''</ulink>''']
29[template static[] '''<phrase role="silver">'''\[static\]'''</phrase>''']
30[template constructor[] '''<phrase role="silver">'''\[constructor\]'''</phrase>''']
31[template destructor[] '''<phrase role="silver">'''\[destructor\]'''</phrase>''']
32[def __POSIX__ /POSIX/]
33[def __Windows__ /Windows/]
34[def __accept__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/accept.html `accept()`]]
35[def __connect__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/connect.html `connect()`]]
36[def __getpeername__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/getpeername.html `getpeername()`]]
37[def __getsockname__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/getsockname.html `getsockname()`]]
38[def __getsockopt__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/getsockopt.html `getsockopt()`]]
39[def __ioctl__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/ioctl.html `ioctl()`]]
40[def __poll__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/poll.html `poll()`]]
41[def __recvfrom__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html `recvfrom()`]]
42[def __sendto__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/sendto.html `sendto()`]]
43[def __setsockopt__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/setsockopt.html `setsockopt()`]]
44[def __shutdown__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/shutdown.html `shutdown()`]]
45[def __socket__ [@http://www.opengroup.org/onlinepubs/9699919799/functions/socket.html `socket()`]]
46
47[/=============================================================================]
48
49Boost.Asio is a cross-platform C++ library for network and low-level I/O programming
50that provides developers with a consistent asynchronous model using a modern
51C++ approach.
52
53[variablelist
54  [
55    [
56      [link boost_asio.overview Overview]
57    ]
58    [
59      An overview of the features included in Boost.Asio, plus rationale and design information.
60    ]
61  ]
62  [
63    [
64      [link boost_asio.using Using, Building, and Configuring Boost.Asio]
65    ]
66    [
67      How to use Boost.Asio in your applications. Includes information on
68      library dependencies and supported platforms.
69    ]
70  ]
71  [
72    [
73      [link boost_asio.tutorial Tutorial]
74    ]
75    [
76      A tutorial that introduces the fundamental concepts required to use
77      Boost.Asio, and shows how to use Boost.Asio to develop simple client and
78      server programs.
79    ]
80  ]
81  [
82    [
83      [link boost_asio.examples Examples]
84    ]
85    [
86      Examples that illustrate the use of Boost.Asio in more complex applications.
87    ]
88  ]
89  [
90    [
91      [link boost_asio.reference Reference]
92    ]
93    [
94      Detailed class and function reference.
95    ]
96  ]
97  [
98    [
99      [link boost_asio.net_ts Networking TS Compatibility]
100    ]
101    [
102      Description of changes to provide compatibility with the "C++ Extensions
103      for Networking" Technical Specification.
104    ]
105  ]
106  [
107    [
108      [link boost_asio.std_executors Proposed Standard Executors]
109    ]
110    [
111      Description of Boost.Asio's support for the proposed standard executors
112      library.
113    ]
114  ]
115  [
116    [
117      [link boost_asio.history Revision History]
118    ]
119    [
120      Log of Boost.Asio changes made in each Boost release.
121    ]
122  ]
123  [
124    [
125      [link boost_asio.index Index]
126    ]
127    [
128      Book-style text index of Boost.Asio documentation.
129    ]
130  ]
131]
132
133[include overview.qbk]
134[include using.qbk]
135[include tutorial.qbk]
136[include examples.qbk]
137[include reference.qbk]
138[include net_ts.qbk]
139[include std_executors.qbk]
140[include history.qbk]
141[xinclude index.xml]
142