From fd07e8879977e08cee2ced8353b47e636cca95fc Mon Sep 17 00:00:00 2001 From: Ivan Baidakou Date: Sat, 29 Jul 2017 21:25:11 +0300 Subject: [PATCH] Improve documentation --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3414a8cb..1da38e7e 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Results achieved with `examples/speed_test_async_multi.cpp` for 1 thread, Intel | bredis (commands/s) | redox (commands/s) | |----------------------------|------------------------------| -| 1.30257e+06 | 1.19214e+06 | +| 1.30257e+06 | 1.19214e+06 | Results are not completely fair, because of usage of different semantics in APIs; however they are still interesting, as there are used different @@ -435,16 +435,16 @@ Represents results of parse attempt. It is `boost::variant` of the following typ `no_enogh_data_t` is empty struct, meaning that buffer just does not contains enough information to completely parse it. -`protocol_error_t` has `std::string what` member, descriping the error in protocol, -(e.g. when type in stream is specified as integer, but it cannot be converted to integer). -This error should never occur in production code, meaning that no (logical) errors -are expected in redis-server nor in bredis parser. The error might occur if buffer -is corrupted. +`protocol_error_t` has `boost::system::error_code code` member, descriping the error +in protocol, (e.g. when type in stream is specified as integer, but it cannot be +converted to integer). This error should never occur in production code, meaning +that no (logical) errors are expected in redis-server nor in bredis parser. The +error might occur if buffer is corrupted. `Policy` (namespace `bredis::parsing_policy`) specifies what to do with with result: -either drop it (`bredis::parsing_policy::drop_result`) or keep it -(`bredis::parsing_policy::keep_result`). The helper -`parse_result_mapper_t` helps to get proper +either drop it (`bredis::parsing_policy::drop_result`) or keep it +(`bredis::parsing_policy::keep_result`). The helper +`parse_result_mapper_t` helps to get proper `positive_parse_result_t` type. `positive_parse_result_t` contains members: