From 25bd6a60dd33cdd71ba5704d8a0ef1cfcfed0050 Mon Sep 17 00:00:00 2001 From: ferrieux Date: Thu, 12 Jan 2012 20:34:59 +0000 Subject: [Bug 3472316] Document the destructive semantics of [fconfigure -error] on sockets. --- doc/socket.n | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/socket.n b/doc/socket.n index bd307b7..c020839 100644 --- a/doc/socket.n +++ b/doc/socket.n @@ -136,6 +136,9 @@ This option gets the current error status of the given socket. This is useful when you need to determine if an asynchronous connect operation succeeded. If there was an error, the error message is returned. If there was no error, an empty string is returned. + +Note that the error status is reset by the read operation; this mimics +the underlying getsockopt(SO_ERROR) call. .TP \fB\-sockname\fR This option returns a list of three elements, the address, the host name -- cgit v0.12