Skip to content

Commit

Permalink
Update generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thed636 authored and elsid committed Sep 15, 2018
1 parent c4035a5 commit 2649db9
Show file tree
Hide file tree
Showing 63 changed files with 811 additions and 342 deletions.
2 changes: 1 addition & 1 deletion docs/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ int main() {

// Request with connection provider, query and callback.
// Provider binds how to get connection with io_context.
ozo::request(ozo::make_provider(io, conn_info), query, ozo::into(rows),
ozo::request(ozo::make_connector(io, conn_info), query, ozo::into(rows),
[&](ozo::error_code ec, auto conn) {
if (ec) {
// Here we got an error, so we can get:
Expand Down
33 changes: 15 additions & 18 deletions docs/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,24 +108,21 @@
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1detail_1_1binder.html" target="_self">binder</a></td><td class="desc"></td></tr>
<tr id="row_0_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>impl</b></td><td class="desc"></td></tr>
<tr id="row_0_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1impl_1_1async__connect__op.html" target="_self">async_connect_op</a></td><td class="desc"></td></tr>
<tr id="row_0_1_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1impl_1_1fetch__context.html" target="_self">fetch_context</a></td><td class="desc"></td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classozo_1_1connection__info.html" target="_self">connection_info</a></td><td class="desc">Connection information </td></tr>
<tr id="row_0_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classozo_1_1connection__pool.html" target="_self">connection_pool</a></td><td class="desc">Connection pool implementationThis is a simple <a href="https://en.wikipedia.org/wiki/Connection_pool">connection pool</a> implementation which can store up to maximum allowed number of connection to the same database. If all connections are busy client request will be placed into the internal queue to wait for free connection. If where is no free connections but it does not hit the limit of connections the new connection will be created via underlying <a class="el" href="group__group-connection-concepts.html#gaeb64411053912bede2d7d7ad7c8057b3" title="ConnectionSource concept. ">ConnectionSource</a> being specified in constructor. All operations are timed out. Connection idle life time is timed out as well. Pool is configurable via constructor and operator() </td></tr>
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1connection__pool__config.html" target="_self">connection_pool_config</a></td><td class="desc">Connection pool configurationConfiguration of the <a class="el" href="classozo_1_1connection__pool.html" title="Connection pool implementationThis is a simple connection pool implementation which can store up to m...">ozo::connection_pool</a>, e.g. how many connection are in the pool, how many queries can be in wait queue if all connections are used by another queries, and how long to keep connection open </td></tr>
<tr id="row_0_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1connection__pool__timeouts.html" target="_self">connection_pool_timeouts</a></td><td class="desc">Timeouts for the <a class="el" href="group__group-connection-functions.html#ga8bedf4875565775ac9b0b91c0ba9ece7" title="Get a connection from provider. ">ozo::get_connection()</a> operationTime restrictions to get connection from the <a class="el" href="classozo_1_1connection__pool.html" title="Connection pool implementationThis is a simple connection pool implementation which can store up to m...">ozo::connection_pool</a> </td></tr>
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classozo_1_1connector.html" target="_self">connector</a></td><td class="desc">Default implementation of ConnectionProvider </td></tr>
<tr id="row_0_7_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1get__connection__type.html" target="_self">get_connection_type</a></td><td class="desc">Connection type getter </td></tr>
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1is__array.html" target="_self">is_array</a></td><td class="desc"></td></tr>
<tr id="row_0_9_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1is__built__in.html" target="_self">is_built_in</a></td><td class="desc">Condition indicates if the specified type is built-in for PG </td></tr>
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1is__composite.html" target="_self">is_composite</a></td><td class="desc">Indicates if type is a composite.In general we suppose that composite is a type being adapted for introspection via Boost.Fusion or Boost.Hana, including tuples and compile-time sequences </td></tr>
<tr id="row_0_11_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1is__nullable_3_01boost_1_1optional_3_01_t_01_4_01_4.html" target="_self">is_nullable&lt; boost::optional&lt; T &gt; &gt;</a></td><td class="desc"></td></tr>
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1is__string.html" target="_self">is_string</a></td><td class="desc"></td></tr>
<tr id="row_0_13_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1time__traits.html" target="_self">time_traits</a></td><td class="desc">Time traits of the library </td></tr>
<tr id="row_0_14_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1type__traits.html" target="_self">type_traits</a></td><td class="desc">Type traits template forward declaration.Type traits contains information related to it's representation in the database. There are two different kind of traits - built-in types with constant OIDs and custom types with database depent OIDs. The functions below describe neccesary traits. For built-in types traits will be defined there. For custom types user must define traits </td></tr>
<tr id="row_0_15_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1type__traits__helper.html" target="_self">type_traits_helper</a></td><td class="desc">Helper defines the way for the type traits definitions.Type is undefined then Name type is not defined </td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>std</b></td><td class="desc"></td></tr>
<tr id="row_1_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1default__delete_3_01_p_gconn_01_4.html" target="_self">default_delete&lt; PGconn &gt;</a></td><td class="desc">Default deleter for PGconn </td></tr>
<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1default__delete_3_01_p_gresult_01_4.html" target="_self">default_delete&lt; PGresult &gt;</a></td><td class="desc">Default deleter for PGresult </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classozo_1_1connection__info.html" target="_self">connection_info</a></td><td class="desc">Connection information </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classozo_1_1connection__pool.html" target="_self">connection_pool</a></td><td class="desc">Connection pool implementationThis is a simple <a href="https://en.wikipedia.org/wiki/Connection_pool">connection pool</a> implementation which can store up to maximum allowed number of connection to the same database. If all connections are busy client request will be placed into the internal queue to wait for free connection. If where is no free connections but it does not hit the limit of connections the new connection will be created via underlying <a class="el" href="group__group-connection-concepts.html#gaeb64411053912bede2d7d7ad7c8057b3" title="ConnectionSource concept. ">ConnectionSource</a> being specified in constructor. All operations are timed out. Connection idle life time is timed out as well. Pool is configurable via constructor and operator() </td></tr>
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1connection__pool__config.html" target="_self">connection_pool_config</a></td><td class="desc">Connection pool configurationConfiguration of the <a class="el" href="classozo_1_1connection__pool.html" title="Connection pool implementationThis is a simple connection pool implementation which can store up to m...">ozo::connection_pool</a>, e.g. how many connection are in the pool, how many queries can be in wait queue if all connections are used by another queries, and how long to keep connection open </td></tr>
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1connection__pool__timeouts.html" target="_self">connection_pool_timeouts</a></td><td class="desc">Timeouts for the <a class="el" href="group__group-connection-functions.html#ga8bedf4875565775ac9b0b91c0ba9ece7" title="Get a connection from provider. ">ozo::get_connection()</a> operationTime restrictions to get connection from the <a class="el" href="classozo_1_1connection__pool.html" title="Connection pool implementationThis is a simple connection pool implementation which can store up to m...">ozo::connection_pool</a> </td></tr>
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classozo_1_1connector.html" target="_self">connector</a></td><td class="desc">Default implementation of ConnectionProvider </td></tr>
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1get__connection__type.html" target="_self">get_connection_type</a></td><td class="desc">Connection type getter </td></tr>
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1is__built__in.html" target="_self">is_built_in</a></td><td class="desc">Condition indicates if the specified type is built-in for PG </td></tr>
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1is__nullable_3_01boost_1_1optional_3_01_t_01_4_01_4.html" target="_self">is_nullable&lt; boost::optional&lt; T &gt; &gt;</a></td><td class="desc"></td></tr>
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1oid__map__t.html" target="_self">oid_map_t</a></td><td class="desc">OidMap implementation type.This type implements OidMap concept based on <code>boost::hana::map</code> </td></tr>
<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1time__traits.html" target="_self">time_traits</a></td><td class="desc">Time traits of the library </td></tr>
<tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1type__traits.html" target="_self">type_traits</a></td><td class="desc">Type traits template forward declaration.Type traits contains information related to it's representation in the database. There are two different kind of traits - built-in types with constant OIDs and custom types with database depent OIDs. The functions below describe neccesary traits. For built-in types traits will be defined there. For custom types user must define traits </td></tr>
<tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structozo_1_1type__traits__helper.html" target="_self">type_traits_helper</a></td><td class="desc">Helper for the type traits definitions </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>std</b></td><td class="desc"></td></tr>
<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1default__delete_3_01_p_gconn_01_4.html" target="_self">default_delete&lt; PGconn &gt;</a></td><td class="desc">Default deleter for PGconn </td></tr>
<tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1default__delete_3_01_p_gresult_01_4.html" target="_self">default_delete&lt; PGresult &gt;</a></td><td class="desc">Default deleter for PGresult </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
3 changes: 2 additions & 1 deletion docs/html/async__connect_8h_source.html

Large diffs are not rendered by default.

Loading

0 comments on commit 2649db9

Please sign in to comment.