Skip to content

Commit 538ce79

Browse files
committed
doc/introduction.md: Add timeout convention
Closes #76
1 parent 98e3a8f commit 538ce79

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/introduction.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,12 @@ The following is a list of API conventions and general reference:
9999
- Some HTTP 2 operations return/throw special [http 2 error objects](#http.h2_error).
100100

101101

102+
### Timeouts
103+
104+
All operations that may block the current thread take a `timeout` argument.
105+
This argument is always the number of seconds to allow before returning `nil, err_msg, ETIMEDOUT` where `err_msg` is a localised error message such as `"connection timed out"`.
106+
107+
102108
## Terminology
103109

104110
Much lua-http terminology is borrowed from HTTP 2.

0 commit comments

Comments
 (0)