event/SocketEvent: document Close()

2020-10-15 16:55:29 +02:00
parent ff6e434caf
commit f8ff597963
1 changed files with 3 additions and 0 deletions
--- a/src/event/SocketEvent.hxx
+++ b/src/event/SocketEvent.hxx
@@ -116,6 +116,9 @@ public:

 	void Open(SocketDescriptor _fd) noexcept;

+	/**
+	 * Close the socket (and cancel all scheduled events).
+	 */
 	void Close() noexcept;

 	unsigned GetScheduledFlags() const noexcept {