ceph/src/Beast/doc/quickref.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "boostbook.dtd">
   3
   4 <!--
   5   Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
   6
   7   Distributed under the Boost Software License, Version 1.0. (See accompanying
   8   file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   9 -->
  10
  11 <informaltable frame="all">
  12   <tgroup cols="4">
  13     <colspec colname="a"/>
  14     <colspec colname="b"/>
  15     <colspec colname="c"/>
  16     <colspec colname="d"/>
  17     <thead>
  18       <row>
  19         <entry valign="center" namest="a" nameend="c">
  20           <bridgehead renderas="sect2">HTTP</bridgehead>
  21         </entry>
  22         <entry valign="center" namest="d" nameend="d">
  23           <bridgehead renderas="sect2">WebSocket</bridgehead>
  24         </entry>
  25       </row>
  26     </thead>
  27     <tbody>
  28       <row>
  29         <entry valign="top">
  30           <bridgehead renderas="sect3">Classes</bridgehead>
  31           <simplelist type="vert" columns="1">
  32             <member><link linkend="beast.ref.http__basic_dynabuf_body">basic_dynabuf_body</link></member>
  33             <member><link linkend="beast.ref.http__basic_fields">basic_fields</link></member>
  34             <member><link linkend="beast.ref.http__basic_parser">basic_parser</link></member>
  35             <member><link linkend="beast.ref.http__fields">fields</link></member>
  36             <member><link linkend="beast.ref.http__header">header</link></member>
  37             <member><link linkend="beast.ref.http__header_parser">header_parser</link></member>
  38             <member><link linkend="beast.ref.http__message">message</link></member>
  39             <member><link linkend="beast.ref.http__message_parser">message_parser</link></member>
  40             <member><link linkend="beast.ref.http__request">request</link></member>
  41             <member><link linkend="beast.ref.http__request_header">request_header</link></member>
  42             <member><link linkend="beast.ref.http__response">response</link></member>
  43             <member><link linkend="beast.ref.http__response_header">response_header</link></member>
  44             <member><link linkend="beast.ref.http__streambuf_body">streambuf_body</link></member>
  45             <member><link linkend="beast.ref.http__string_body">string_body</link></member>
  46           </simplelist>
  47           <bridgehead renderas="sect3">rfc7230</bridgehead>
  48           <simplelist type="vert" columns="1">
  49
  50            <member><link linkend="beast.ref.http__ext_list">ext_list</link></member>
  51            <member><link linkend="beast.ref.http__opt_token_list">opt_token_list</link></member>
  52            <member><link linkend="beast.ref.http__param_list">param_list</link></member>
  53            <member><link linkend="beast.ref.http__token_list">token_list</link></member>
  54           </simplelist>
  55         </entry>
  56         <entry valign="top">
  57           <bridgehead renderas="sect3">Functions</bridgehead>
  58           <simplelist type="vert" columns="1">
  59             <member><link linkend="beast.ref.http__async_read">async_read</link></member>
  60             <member><link linkend="beast.ref.http__async_read_some">async_read_some</link></member>
  61             <member><link linkend="beast.ref.http__async_write">async_write</link></member>
  62             <member><link linkend="beast.ref.http__chunk_encode">chunk_encode</link></member>
  63             <member><link linkend="beast.ref.http__chunk_encode_final">chunk_encode_final</link></member>
  64             <member><link linkend="beast.ref.http__swap">swap</link></member>
  65             <member><link linkend="beast.ref.http__is_keep_alive">is_keep_alive</link></member>
  66             <member><link linkend="beast.ref.http__is_upgrade">is_upgrade</link></member>
  67             <member><link linkend="beast.ref.http__operator_ls_">operator&lt;&lt;</link></member>
  68             <member><link linkend="beast.ref.http__prepare">prepare</link></member>
  69             <member><link linkend="beast.ref.http__read">read</link></member>
  70             <member><link linkend="beast.ref.http__read_some">read_some</link></member>
  71             <member><link linkend="beast.ref.http__reason_string">reason_string</link></member>
  72             <member><link linkend="beast.ref.http__write">write</link></member>
  73           </simplelist>
  74           <bridgehead renderas="sect3">Type Traits</bridgehead>
  75           <simplelist type="vert" columns="1">
  76            <member><link linkend="beast.ref.http__is_Body">is_Body</link></member>
  77            <member><link linkend="beast.ref.http__is_Reader">is_Reader</link></member>
  78            <member><link linkend="beast.ref.http__is_Writer">is_Writer</link></member>
  79            <member><link linkend="beast.ref.http__has_reader">has_reader</link></member>
  80            <member><link linkend="beast.ref.http__has_writer">has_writer</link></member>
  81           </simplelist>
  82         </entry>
  83         <entry valign="top">
  84           <bridgehead renderas="sect3">Constants</bridgehead>
  85           <simplelist type="vert" columns="1">
  86             <member><link linkend="beast.ref.http__connection">connection</link></member>
  87             <member><link linkend="beast.ref.http__error">error</link></member>
  88           </simplelist>
  89           <bridgehead renderas="sect3">Concepts</bridgehead>
  90           <simplelist type="vert" columns="1">
  91             <member><link linkend="beast.ref.Body">Body</link></member>
  92             <member><link linkend="beast.ref.Field">Field</link></member>
  93             <member><link linkend="beast.ref.FieldSequence">FieldSequence</link></member>
  94             <member><link linkend="beast.ref.Reader">Reader</link></member>
  95             <member><link linkend="beast.ref.Writer">Writer</link></member>
  96           </simplelist>
  97         </entry>
  98         <entry valign="top">
  99           <bridgehead renderas="sect3">Classes</bridgehead>
 100           <simplelist type="vert" columns="1">
 101             <member><link linkend="beast.ref.websocket__close_reason">close_reason</link></member>
 102             <member><link linkend="beast.ref.websocket__ping_data">ping_data</link></member>
 103             <member><link linkend="beast.ref.websocket__stream">stream</link></member>
 104             <member><link linkend="beast.ref.websocket__reason_string">reason_string</link></member>
 105             <member><link linkend="beast.ref.websocket__teardown_tag">teardown_tag</link></member>
 106           </simplelist>
 107           <bridgehead renderas="sect3">Functions</bridgehead>
 108           <simplelist type="vert" columns="1">
 109             <member><link linkend="beast.ref.websocket__async_teardown">async_teardown</link></member>
 110             <member><link linkend="beast.ref.websocket__teardown">teardown</link></member>
 111           </simplelist>
 112           <bridgehead renderas="sect3">Options</bridgehead>
 113           <simplelist type="vert" columns="1">
 114             <member><link linkend="beast.ref.websocket__auto_fragment">auto_fragment</link></member>
 115             <member><link linkend="beast.ref.websocket__decorate">decorate</link></member>
 116             <member><link linkend="beast.ref.websocket__keep_alive">keep_alive</link></member>
 117             <member><link linkend="beast.ref.websocket__message_type">message_type</link></member>
 118             <member><link linkend="beast.ref.websocket__permessage_deflate">permessage_deflate</link></member>
 119             <member><link linkend="beast.ref.websocket__ping_callback">ping_callback</link></member>
 120             <member><link linkend="beast.ref.websocket__read_buffer_size">read_buffer_size</link></member>
 121             <member><link linkend="beast.ref.websocket__read_message_max">read_message_max</link></member>
 122             <member><link linkend="beast.ref.websocket__write_buffer_size">write_buffer_size</link></member>
 123           </simplelist>
 124           <bridgehead renderas="sect3">Constants</bridgehead>
 125           <simplelist type="vert" columns="1">
 126             <member><link linkend="beast.ref.websocket__close_code">close_code</link></member>
 127             <member><link linkend="beast.ref.websocket__error">error</link></member>
 128             <member><link linkend="beast.ref.websocket__opcode">opcode</link></member>
 129           </simplelist>
 130         </entry>
 131       </row>
 132     </tbody>
 133   </tgroup>
 134   <tgroup cols="4">
 135     <colspec colname="a"/>
 136     <colspec colname="b"/>
 137     <colspec colname="c"/>
 138     <colspec colname="d"/>
 139     <colspec colname="e"/>
 140     <thead>
 141       <row>
 142         <entry valign="center" namest="a" nameend="d">
 143           <bridgehead renderas="sect2">Core</bridgehead>
 144         </entry>
 145         <entry valign="center" namest="e" nameend="e">
 146           <bridgehead renderas="sect2">ZLib</bridgehead>
 147         </entry>
 148       </row>
 149     </thead>
 150     <tbody>
 151       <row>
 152         <entry valign="top">
 153           <bridgehead renderas="sect3">Classes</bridgehead>
 154           <simplelist type="vert" columns="1">
 155             <member><link linkend="beast.ref.async_completion">async_completion</link></member>
 156             <member><link linkend="beast.ref.basic_flat_streambuf">basic_flat_streambuf</link></member>
 157             <member><link linkend="beast.ref.basic_streambuf">basic_streambuf</link></member>
 158             <member><link linkend="beast.ref.buffers_adapter">buffers_adapter</link></member>
 159             <member><link linkend="beast.ref.consuming_buffers">consuming_buffers</link></member>
 160             <member><link linkend="beast.ref.dynabuf_readstream">dynabuf_readstream</link></member>
 161             <member><link linkend="beast.ref.errc">errc</link></member>
 162             <member><link linkend="beast.ref.error_category">error_category</link></member>
 163             <member><link linkend="beast.ref.error_code">error_code</link></member>
 164             <member><link linkend="beast.ref.error_condition">error_condition</link></member>
 165             <member><link linkend="beast.ref.flat_streambuf">flat_streambuf</link></member>
 166             <member><link linkend="beast.ref.handler_alloc">handler_alloc</link></member>
 167             <member><link linkend="beast.ref.handler_ptr">handler_ptr</link></member>
 168             <member><link linkend="beast.ref.static_streambuf">static_streambuf</link></member>
 169             <member><link linkend="beast.ref.static_streambuf_n">static_streambuf_n</link></member>
 170             <member><link linkend="beast.ref.static_string">static_string</link></member>
 171             <member><link linkend="beast.ref.streambuf">streambuf</link></member>
 172             <member><link linkend="beast.ref.system_error">system_error</link></member>
 173           </simplelist>
 174         </entry>
 175         <entry valign="top">
 176           <bridgehead renderas="sect3">Functions</bridgehead>
 177           <simplelist type="vert" columns="1">
 178             <member><link linkend="beast.ref.bind_handler">bind_handler</link></member>
 179             <member><link linkend="beast.ref.buffer_cat">buffer_cat</link></member>
 180             <member><link linkend="beast.ref.prepare_buffer">prepare_buffer</link></member>
 181             <member><link linkend="beast.ref.prepare_buffers">prepare_buffers</link></member>
 182             <member><link linkend="beast.ref.system_category">system_category</link></member>
 183             <member><link linkend="beast.ref.to_string">to_string</link></member>
 184             <member><link linkend="beast.ref.write">write</link></member>
 185           </simplelist>
 186         </entry>
 187         <entry valign="top">
 188           <bridgehead renderas="sect3">Type Traits</bridgehead>
 189           <simplelist type="vert" columns="1">
 190             <member><link linkend="beast.ref.is_AsyncReadStream">is_AsyncReadStream</link></member>
 191             <member><link linkend="beast.ref.is_AsyncWriteStream">is_AsyncWriteStream</link></member>
 192             <member><link linkend="beast.ref.is_AsyncStream">is_AsyncStream</link></member>
 193             <member><link linkend="beast.ref.is_BufferSequence">is_BufferSequence</link></member>
 194             <member><link linkend="beast.ref.is_CompletionHandler">is_CompletionHandler</link></member>
 195             <member><link linkend="beast.ref.is_ConstBufferSequence">is_ConstBufferSequence</link></member>
 196             <member><link linkend="beast.ref.is_DynamicBuffer">is_DynamicBuffer</link></member>
 197             <member><link linkend="beast.ref.is_MutableBufferSequence">is_MutableBufferSequence</link></member>
 198             <member><link linkend="beast.ref.is_SyncReadStream">is_SyncReadStream</link></member>
 199             <member><link linkend="beast.ref.is_SyncStream">is_SyncStream</link></member>
 200             <member><link linkend="beast.ref.is_SyncWriteStream">is_SyncWriteStream</link></member>
 201           </simplelist>
 202         </entry>
 203         <entry valign="top">
 204           <bridgehead renderas="sect3">Concepts</bridgehead>
 205           <simplelist type="vert" columns="1">
 206             <member><link linkend="beast.ref.streams.AsyncStream">AsyncStream</link></member>
 207             <member><link linkend="beast.ref.BufferSequence">BufferSequence</link></member>
 208             <member><link linkend="beast.ref.DynamicBuffer">DynamicBuffer</link></member>
 209             <member><link linkend="beast.ref.streams.Stream">Stream</link></member>
 210             <member><link linkend="beast.ref.streams.SyncStream">SyncStream</link></member>
 211           </simplelist>
 212         </entry>
 213         <entry valign="top">
 214           <bridgehead renderas="sect3">Classes</bridgehead>
 215           <simplelist type="vert" columns="1">
 216             <member><link linkend="beast.ref.zlib__deflate_stream">deflate_stream</link></member>
 217             <member><link linkend="beast.ref.zlib__inflate_stream">inflate_stream</link></member>
 218             <member><link linkend="beast.ref.zlib__z_params">z_params</link></member>
 219           </simplelist>
 220           <bridgehead renderas="sect3">Functions</bridgehead>
 221           <simplelist type="vert" columns="1">
 222             <member><link linkend="beast.ref.zlib__deflate_upper_bound">deflate_upper_bound</link></member>
 223           </simplelist>
 224           <bridgehead renderas="sect3">Constants</bridgehead>
 225           <simplelist type="vert" columns="1">
 226             <member><link linkend="beast.ref.zlib__error">error</link></member>
 227             <member><link linkend="beast.ref.zlib__Flush">Flush</link></member>
 228             <member><link linkend="beast.ref.zlib__Strategy">Strategy</link></member>
 229           </simplelist>
 230         </entry>
 231       </row>
 232     </tbody>
 233   </tgroup>
 234   <tgroup cols="1">
 235     <colspec colname="a"/>
 236     <thead>
 237       <row>
 238         <entry valign="center" namest="a" nameend="a">
 239           <bridgehead renderas="sect2">Diagnostic</bridgehead>
 240         </entry>
 241       </row>
 242     </thead>
 243     <tbody>
 244       <row>
 245         <entry valign="top">
 246           <simplelist type="vert" columns="1">
 247             <member><link linkend="beast.ref.doc_debug">doc_debug</link></member>
 248             <member><link linkend="beast.ref.nested__nested_doc_debug">nested_doc_debug</link></member>
 249           </simplelist>
 250         </entry>
 251       </row>
 252     </tbody>
 253   </tgroup>
 254 </informaltable>