Skip to content

Commit ae004f3

Browse files
committed
readme: start words with capital letters in headers
Just prettifying the readme.
1 parent 0f65846 commit ae004f3

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ as template parameter of buffer.
107107
Connector can be embedded in any C++ application with including main header:
108108
`#include "<path-to-cloned-repo>/src/Client/Connector.hpp"`
109109

110-
### Objects instantiation
110+
### Objects Instantiation
111111

112112
To create client one should specify buffer's and network provider's implementations
113113
as template parameters. Connector's main class has the following signature:
@@ -144,7 +144,7 @@ pass three arguments: connection instance, address and port.
144144
int rc = client.connect(conn, address, port);
145145
```
146146

147-
### Error handling
147+
### Error Handling
148148

149149
Implementation of connector is exception
150150
free, so we rely on return codes: in case of fail, `connect()` will return `rc < 0`.
@@ -159,7 +159,7 @@ if (rc != 0) {
159159
To reset connection after errors (clean up error message and connection status),
160160
one can use `Connection::reset()`.
161161

162-
### Preparing requests
162+
### Preparing Requests
163163

164164
To execute simplest request (i.e. ping), one can invoke corresponding method of
165165
connection object:
@@ -170,7 +170,7 @@ Each request method returns request id, which is sort of future. It can be used
170170
to get the result of request execution once it is ready (i.e. response). Requests
171171
are queued in the input buffer of connection until `Connector::wait()` is called.
172172

173-
### Sending requests
173+
### Sending Requests
174174

175175
That said, to send requests to the server side, we should invoke `client.wait()`:
176176
```c++
@@ -182,7 +182,7 @@ request is ready, `wait()` terminates. It also provides negative return code in
182182
case of system related fails (e.g. broken or time outed connection). If `wait()`
183183
returns 0, then response is received and expected to be parsed.
184184

185-
### Receiving responses
185+
### Receiving Responses
186186

187187
To get the response when it is ready, we can use `Connection::getResponse()`.
188188
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
200200
tuples are not decoded and come in form of pointers to the start and end of
201201
msgpacks. See section below to understand how to decode tuples.
202202

203-
### Data manipulation
203+
### Data Manipulation
204204

205205
Now let's consider a bit more sophisticated requests.
206206
Assume we have space with `id = 512` and following format on the server:
@@ -218,7 +218,7 @@ auto i = conn.space[512].index[1];
218218
rid_t select = i.select(std::make_tuple(1), 1, 0 /*offset*/, IteratorType::EQ);
219219
```
220220

221-
### Data readers
221+
### Data Readers
222222

223223
Responses from server contain raw data (i.e. encoded into MsgPack tuples).
224224
Let's define structure describing data stored in space `t`:

0 commit comments

Comments
 (0)