diff options
| author | Luke T. Shumaker <lukeshu@lukeshu.com> | 2025-03-17 19:11:37 -0600 |
|---|---|---|
| committer | Luke T. Shumaker <lukeshu@lukeshu.com> | 2025-03-26 12:18:47 -0600 |
| commit | f7eb78bd9f38294814c05bcf7867ce6c4414c77c (patch) | |
| tree | b0d412209772e09700821f6cb78152fe229229a6 | |
| parent | 4a4c44190057cef139c2cde5c7258854caa7558b (diff) | |
lib9p: srv.h: Add some doc comments
| -rw-r--r-- | lib9p/include/lib9p/srv.h | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/lib9p/include/lib9p/srv.h b/lib9p/include/lib9p/srv.h index f94fdf8..a714125 100644 --- a/lib9p/include/lib9p/srv.h +++ b/lib9p/include/lib9p/srv.h @@ -43,7 +43,23 @@ lo_interface lib9p_srv_dio; #define lib9p_srv_file_LO_IFACE \ /* resource management **********************************************/ \ \ + /** \ + * free() is be called when all FIDs associated with the file are \ + * clunked. \ + * \ + * free() MUST NOT error. \ + */ \ LO_FUNC(void , free ) \ + \ + /** \ + * qid() is called frequently and returns the current QID of the file. \ + * The .path field MUST never change, the .type field may change in \ + * response to wstat() calls (but the QT_DIR bit MUST NOT change), and \ + * the .vers field may change frequently in response to any number of \ + * things (wstat(), write(), or non-9P events). \ + * \ + * qid() MUST NOT error. \ + */ \ LO_FUNC(struct lib9p_qid , qid ) \ \ /* non-"opened" generic I/O *****************************************/ \ |