Add warning doc about Windows

It's an implementation detail worth mentioning. Change-Id: I8a8bcd9b8705089792ed28a86c86381e937bb401 Reviewed-on: https://codereview.kdab.com/c/kdab/kdutils/+/132216 Reviewed-by: Mike Krus <[email protected]> Tested-by: Continuous Integration <[email protected]>
KDAB · Oct 18, 2023 · 4258a63 · 4258a63
1 parent a0f81ed
commit 4258a63
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/KDFoundation/file_descriptor_notifier.h b/src/KDFoundation/file_descriptor_notifier.h
@@ -20,6 +20,13 @@
 
 namespace KDFoundation {
 
+/// @brief Get async notifications about activity on file descriptors
+///
+/// @warning On Windows, the write notification is edge triggered meaning that
+/// it will be raised only if the internal socket buffer is fully filled, not
+/// after every successful write. This means that socket should be written to
+/// until WSAEWOULDBLOCK is returned from the send-type operation running on the
+/// socket to receive next write notification.
 class KDFOUNDATION_API FileDescriptorNotifier : public Object
 {
 public: