MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-06-06 12:08:56 +02:00
Code Issues Releases Wiki Activity

doc: Add yield/IO's marking section in STYLE.

Browse source
This commit is contained in:
Jason Volk 2018-05-04 15:29:04 -07:00
parent 7ca2e8797d
commit e24295c640
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/STYLE.md
View file

@ -401,3 +401,15 @@ exceptions, etc). Any exception may still come out of that nothrow overload;
technically including the specific exception if it came from somewhere else!
When no exceptions whatsoever are expected, the `noexcept` keyword is used.
#### Indications of yielding and IO's
There is a section on how yielding and IO can occur far up the stack from a
benign-looking callsite in ctx/README. We try to make comments to indicate
these things directly in the definitions and certainly in documentation.
Some of those indications may say nothing more than `[GET]` and `[SET]` without
any other comment. That is the minimum acceptable marking for something which
will likely do read or write IO respectively to disk or even the network. In
any such case the ircd::ctx will definitely yield if that happens.