summaryrefslogtreecommitdiff
path: root/libs/asio/doc/asio.qbk
blob: 0a20fd1952b6783b5dc6423cd04a7b44a62ec0c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
[/
 / Copyright (c) 2003-2014 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)
 /]

[library Boost.Asio
    [quickbook 1.4]
    [copyright 2003 - 2014 Christopher M. Kohlhoff]
    [purpose Networking library]
    [license
        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])
    ]
    [authors [Kohlhoff, Christopher]]
    [category template]
    [category generic]
]

[template mdash[] '''— ''']
[template indexterm1[term1] '''<indexterm><primary>'''[term1]'''</primary></indexterm>''']
[template indexterm2[term1 term2] '''<indexterm><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
[template ticket[number]'''<ulink url="https://svn.boost.org/trac/boost/ticket/'''[number]'''">'''#[number]'''</ulink>''']
[def __POSIX__ /POSIX/]
[def __Windows__ /Windows/]
[def __accept__ [@http://www.opengroup.org/onlinepubs/000095399/functions/accept.html `accept()`]]
[def __connect__ [@http://www.opengroup.org/onlinepubs/000095399/functions/connect.html `connect()`]]
[def __getpeername__ [@http://www.opengroup.org/onlinepubs/000095399/functions/getpeername.html `getpeername()`]]
[def __getsockname__ [@http://www.opengroup.org/onlinepubs/000095399/functions/getsockname.html `getsockname()`]]
[def __getsockopt__ [@http://www.opengroup.org/onlinepubs/000095399/functions/getsockopt.html `getsockopt()`]]
[def __ioctl__ [@http://www.opengroup.org/onlinepubs/000095399/functions/ioctl.html `ioctl()`]]
[def __recvfrom__ [@http://www.opengroup.org/onlinepubs/000095399/functions/recvfrom.html `recvfrom()`]]
[def __sendto__ [@http://www.opengroup.org/onlinepubs/000095399/functions/sendto.html `sendto()`]]
[def __setsockopt__ [@http://www.opengroup.org/onlinepubs/000095399/functions/setsockopt.html `setsockopt()`]]
[def __socket__ [@http://www.opengroup.org/onlinepubs/000095399/functions/socket.html `socket()`]]

[/=============================================================================]

Boost.Asio is a cross-platform C++ library for network and low-level I/O programming
that provides developers with a consistent asynchronous model using a modern
C++ approach.

[variablelist
  [
    [
      [link boost_asio.overview Overview]
    ]
    [
      An overview of the features included in Boost.Asio, plus rationale and design information.
    ]
  ]
  [
    [
      [link boost_asio.using Using Boost.Asio]
    ]
    [
      How to use Boost.Asio in your applications. Includes information on
      library dependencies and supported platforms.
    ]
  ]
  [
    [
      [link boost_asio.tutorial Tutorial]
    ]
    [
      A tutorial that introduces the fundamental concepts required to use
      Boost.Asio, and shows how to use Boost.Asio to develop simple client and
      server programs.
    ]
  ]
  [
    [
      [link boost_asio.examples Examples]
    ]
    [
      Examples that illustrate the use of Boost.Asio in more complex applications.
    ]
  ]
  [
    [
      [link boost_asio.reference Reference]
    ]
    [
      Detailed class and function reference.
    ]
  ]
  [
    [
      [link boost_asio.history Revision History]
    ]
    [
      Log of Boost.Asio changes made in each Boost release.
    ]
  ]
  [
    [
      [link boost_asio.index Index]
    ]
    [
      Book-style text index of Boost.Asio documentation.
    ]
  ]
]

[include overview.qbk]
[include using.qbk]
[include tutorial.qbk]
[include examples.qbk]
[include reference.qbk]
[include history.qbk]
[xinclude index.xml]