Skip to content

Commit 8e2aaed

Browse files
committed
readme: document Connection::hasError()
We need to get this method covered because we are going to refer to it from section describing waiting methods (like `Connector::wait()`).
1 parent 49403f4 commit 8e2aaed

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,10 @@ if (rc != 0) {
156156
}
157157
```
158158

159+
Note that some methods can return `rc < 0` without any error. For example, `wait`
160+
can return `-1` when timeout is exceeded. In order to differentiate between such
161+
situations, one can use method `Connection::hasError()`.
162+
159163
To reset connection after errors (clean up error message and connection status),
160164
one can use `Connection::reset()`.
161165

0 commit comments

Comments
 (0)