@@ -107,7 +107,7 @@ as template parameter of buffer.
107
107
Connector can be embedded in any C++ application with including main header:
108
108
` #include "<path-to-cloned-repo>/src/Client/Connector.hpp" `
109
109
110
- ### Objects instantiation
110
+ ### Objects Instantiation
111
111
112
112
To create client one should specify buffer's and network provider's implementations
113
113
as template parameters. Connector's main class has the following signature:
@@ -144,7 +144,7 @@ pass three arguments: connection instance, address and port.
144
144
int rc = client.connect(conn, address, port);
145
145
```
146
146
147
- ### Error handling
147
+ ### Error Handling
148
148
149
149
Implementation of connector is exception
150
150
free, so we rely on return codes: in case of fail, ` connect() ` will return ` rc < 0 ` .
@@ -159,7 +159,7 @@ if (rc != 0) {
159
159
To reset connection after errors (clean up error message and connection status),
160
160
one can use ` Connection::reset() ` .
161
161
162
- ### Preparing requests
162
+ ### Preparing Requests
163
163
164
164
To execute simplest request (i.e. ping), one can invoke corresponding method of
165
165
connection object:
@@ -170,7 +170,7 @@ Each request method returns request id, which is sort of future. It can be used
170
170
to get the result of request execution once it is ready (i.e. response). Requests
171
171
are queued in the input buffer of connection until ` Connector::wait() ` is called.
172
172
173
- ### Sending requests
173
+ ### Sending Requests
174
174
175
175
That said, to send requests to the server side, we should invoke ` client.wait() ` :
176
176
``` c++
@@ -182,7 +182,7 @@ request is ready, `wait()` terminates. It also provides negative return code in
182
182
case of system related fails (e.g. broken or time outed connection). If ` wait() `
183
183
returns 0, then response is received and expected to be parsed.
184
184
185
- ### Receiving responses
185
+ ### Receiving Responses
186
186
187
187
To get the response when it is ready, we can use ` Connection::getResponse() ` .
188
188
It takes request id and returns optional object containing response (` nullptr `
@@ -200,7 +200,7 @@ either runtime error(s) (accessible by `response.body.error_stack`) or data
200
200
tuples are not decoded and come in form of pointers to the start and end of
201
201
msgpacks. See section below to understand how to decode tuples.
202
202
203
- ### Data manipulation
203
+ ### Data Manipulation
204
204
205
205
Now let's consider a bit more sophisticated requests.
206
206
Assume we have space with ` id = 512 ` and following format on the server:
@@ -218,7 +218,7 @@ auto i = conn.space[512].index[1];
218
218
rid_t select = i.select(std::make_tuple(1 ), 1 , 0 /* offset*/ , IteratorType::EQ);
219
219
```
220
220
221
- ### Data readers
221
+ ### Data Readers
222
222
223
223
Responses from server contain raw data (i.e. encoded into MsgPack tuples).
224
224
Let's define structure describing data stored in space ` t ` :
0 commit comments