libs/asio/doc/requirements.qbk

   1 [/
   2  / Copyright (c) 2003-2014 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:requirements Type Requirements]
   9
  10 Throughout this documentation, the names of the template parameters are used to
  11 express type requirements, as listed in the table below.
  12
  13 [table Template parameters and type requirements
  14   [[Template Parameter Name][Type Requirements]]
  15   [
  16     [`AcceptHandler`]
  17     [[link boost_asio.requirements.AcceptHandler accept handler]]
  18   ]
  19   [
  20     [`AsyncReadStream`]
  21     [[link boost_asio.requirements.AsyncReadStream buffer-oriented asynchronous
  22     read stream]]
  23   ]
  24   [
  25     [`AsyncWriteStream`]
  26     [[link boost_asio.requirements.AsyncWriteStream buffer-oriented asynchronous
  27     write stream]]
  28   ]
  29   [
  30     [`CompletionHandler`]
  31     [[link boost_asio.requirements.CompletionHandler completion handler]]
  32   ]
  33   [
  34     [`ConnectHandler`]
  35     [[link boost_asio.requirements.ConnectHandler connect handler]]
  36   ]
  37   [
  38     [`ConstBufferSequence`]
  39     [[link boost_asio.requirements.ConstBufferSequence constant buffer
  40     sequence]]
  41   ]
  42   [
  43     [`ConvertibleToConstBuffer`]
  44     [[link boost_asio.requirements.ConvertibleToConstBuffer convertible to a
  45     constant buffer]]
  46   ]
  47   [
  48     [`ConvertibleToMutableBuffer`]
  49     [[link boost_asio.requirements.ConvertibleToMutableBuffer convertible to a
  50     mutable buffer]]
  51   ]
  52   [
  53     [`DatagramSocketService`]
  54     [[link boost_asio.requirements.DatagramSocketService datagram socket
  55     service]]
  56   ]
  57   [
  58     [`GettableSocketOption`]
  59     [[link boost_asio.requirements.GettableSocketOption gettable socket option]]
  60   ]
  61   [
  62     [`Handler`]
  63     [[link boost_asio.requirements.Handler handler]]
  64   ]
  65   [
  66     [`InternetProtocol`]
  67     [[link boost_asio.requirements.InternetProtocol Internet protocol]]
  68   ]
  69   [
  70     [`IoControlCommand`]
  71     [[link boost_asio.requirements.IoControlCommand I/O control command]]
  72   ]
  73   [
  74     [`IoObjectService`]
  75     [[link boost_asio.requirements.IoObjectService I/O object service]]
  76   ]
  77   [
  78     [`MutableBufferSequence`]
  79     [[link boost_asio.requirements.MutableBufferSequence mutable buffer
  80     sequence]]
  81   ]
  82   [
  83     [`Protocol`]
  84     [[link boost_asio.requirements.Protocol protocol]]
  85   ]
  86   [
  87     [`ReadHandler`]
  88     [[link boost_asio.requirements.ReadHandler read handler]]
  89   ]
  90   [
  91     [`ResolveHandler`]
  92     [[link boost_asio.requirements.ResolveHandler resolve handler]]
  93   ]
  94   [
  95     [`ResolverService`]
  96     [[link boost_asio.requirements.ResolverService resolver service]]
  97   ]
  98   [
  99     [`Service`]
 100     [[link boost_asio.requirements.Service service]]
 101   ]
 102   [
 103     [`SettableSocketOption`]
 104     [[link boost_asio.requirements.SettableSocketOption settable socket option]]
 105   ]
 106   [
 107     [`SocketAcceptorService`]
 108     [[link boost_asio.requirements.SocketAcceptorService socket acceptor
 109     service]]
 110   ]
 111   [
 112     [`SocketService`]
 113     [[link boost_asio.requirements.SocketService socket service]]
 114   ]
 115   [
 116     [`StreamSocketService`]
 117     [[link boost_asio.requirements.StreamSocketService stream socket service]]
 118   ]
 119   [
 120     [`SyncReadStream`]
 121     [[link boost_asio.requirements.SyncReadStream buffer-oriented synchronous
 122     read stream]]
 123   ]
 124   [
 125     [`SyncWriteStream`]
 126     [[link boost_asio.requirements.SyncWriteStream buffer-oriented synchronous
 127     write stream]]
 128   ]
 129   [
 130     [`TimerService`]
 131     [[link boost_asio.requirements.TimerService timer service]]
 132   ]
 133   [
 134     [`TimeTraits`]
 135     [[link boost_asio.requirements.TimeTraits time traits]]
 136   ]
 137   [
 138     [`WaitHandler`]
 139     [[link boost_asio.requirements.WaitHandler wait handler]]
 140   ]
 141   [
 142     [`WriteHandler`]
 143     [[link boost_asio.requirements.WriteHandler write handler]]
 144   ]
 145 ]
 146
 147 [include requirements/asynchronous_operations.qbk]
 148 [include requirements/AcceptHandler.qbk]
 149 [include requirements/AsyncReadStream.qbk]
 150 [include requirements/AsyncWriteStream.qbk]
 151 [include requirements/CompletionHandler.qbk]
 152 [include requirements/ConnectHandler.qbk]
 153 [include requirements/ConstBufferSequence.qbk]
 154 [include requirements/ConvertibleToConstBuffer.qbk]
 155 [include requirements/ConvertibleToMutableBuffer.qbk]
 156 [include requirements/DatagramSocketService.qbk]
 157 [include requirements/Endpoint.qbk]
 158 [include requirements/GettableSocketOption.qbk]
 159 [include requirements/Handler.qbk]
 160 [include requirements/InternetProtocol.qbk]
 161 [include requirements/IoControlCommand.qbk]
 162 [include requirements/IoObjectService.qbk]
 163 [include requirements/MutableBufferSequence.qbk]
 164 [include requirements/Protocol.qbk]
 165 [include requirements/ReadHandler.qbk]
 166 [include requirements/ResolveHandler.qbk]
 167 [include requirements/ResolverService.qbk]
 168 [include requirements/Service.qbk]
 169 [include requirements/SettableSocketOption.qbk]
 170 [include requirements/SocketAcceptorService.qbk]
 171 [include requirements/SocketService.qbk]
 172 [include requirements/StreamSocketService.qbk]
 173 [include requirements/SyncReadStream.qbk]
 174 [include requirements/SyncWriteStream.qbk]
 175 [include requirements/TimeTraits.qbk]
 176 [include requirements/TimerService.qbk]
 177 [include requirements/WaitHandler.qbk]
 178 [include requirements/WriteHandler.qbk]
 179
 180 [endsect]